Merge pull request #89 from ForeverAndEverTeam/Nuke

Major update No. 2 (TO BE MERGED)

README.md

@@ -1,160 +1,123 @@
-# Forever and Ever (FAE)
-"Forever & Ever" is a mod for the free game [Doki Doki Literature Club](https://www.ddlc.moe) from [Team Salvato](http://teamsalvato.com/). In it, you can become closer to Sayori than ever before! You have all the time in the world to build the perfect relationship with our cinnamon bun as the star of the show. At the heart of the mod, we took a mental health based approach in line with the experiences Sayori had in the original game, so we can hopefully support people by offering a source of positivity, advice, and unconditional understanding. 
-Currently we have a whole range of unique dialogue, questions, and games for you and Sayori to enjoy, and we have so many more ideas for the near future! We're very active around the mod and on our discord server and we promise to deliver frequent updates and announcements so there's always something new and exciting to do! 
-Why not get creative and try to add a feature or two yourself? (I'm sure she'd love that!)
-
-Please check the [Releases](https://github.com/ForeverAndEverTeam/fae-mod/releases) page for the latest stable build.
-Also, please don't clone the master branch to download the mod. 
-Use a stable release instead!
-
-## СOMPATIBILITY NOTICE 
-This mod is incompatible with Doki Doki Literature Club Plus. 
-If you own a DDLC+ copy, please download the original game from it's [official website](https://ddlc.moe) to install the mod.
-
-## REPORTING BUGS
-Please report bugs on our [issues](https://github.com/ForeverAndEverTeam/fae-mod/issues) page.
-Please be as detailed as possible when reporting, to make our lives easier when fixing.
-
-## CLOUD STORAGE
-Please ensure you run the mod from LOCAL storage.
-Running the mod from locations such as OneDrive cause bugs that we can't fix.
-
-<details>
-  <summary>NEW CREDITS</summary>
-
-## DIRECTOR
-
-[Orcaramelo](https://github.com/Orcaramelo)
-
-## PROGRAMMING
-
-[Nathan](https://github.com/TRIDENT1313) (Lead)
-
-## ART
-
-[Orcaramelo](https://github.com/Orcaramelo) (Lead), [Nemu-sus](https://github.com/Nemu-sus)
-
-## MUSIC
-
-SlightlyAmiss (Theme), [Multimokia](https://github.com/multimokia) (Music box loop)
-
-## WRITING
-
-Sayori, [Orcaramelo](https://github.com/Orcaramelo), [Emilia/Monika (EYLO)](https://www.reddit.com/u/EmiliaMonika?utm_medium=android_app&utm_source=share), [Otter](https://github.com/my-otter-self), [Nathan](https://github.com/TRIDENT1313), Sobb
-
-</details>
-
-<details>
-  <summary>SPECIAL THANKS</summary>
-
-[Emilia/Monika (EYLO)](https://www.reddit.com/u/EmiliaMonika?utm_medium=android_app&utm_source=share), [Nathan](https://github.com/TRIDENT1313)
+<p align="center">
+    <img src="https://justnatsuki.club/img/guest/fae/forever_and_ever_logo.png" height="300"/>
+</p>
+<br>
 
+# Forever and Ever (FAE)
 
-Team Salvato and Team Monika, The "Just Natsuki" team, Independent supporters of "Just {doki_name}" mod, The Ren'Py developer team, The Reddit DDLC community, The Russian DDLC community
-
-</details>
-
-<details>
-  <summary>LEGACY CREDITS</summary>
-
-## Project Lead:
-Alexander Osipov (aka AlexanDDOS, GitHub, Reddit, VK, FB)
-
-## Programming:
-
-AlexanDDOS
-
-vignedev
-
-Dan Salvato (original scripts)
-
-DDLC Mod Template team (mod base)
-
-ElReyZero (small fixes)
-
-## Old Sayori Sprite Artists:
-
-Excluded since 0.4.0
-
-Fj0rd_ (Reddit, the original Sayori art)
-
-AlexanDDOS (Sprite compositor & editor)
-
-## New Sayori Sprite Artists:
-
-Orcaramelo
+_Forever & Ever_ is a mod for the free game [Doki Doki Literature Club](https://www.ddlc.moe) from [Team Salvato](http://teamsalvato.com/).
 
-Nemu-sus
+In it, you can become closer to Sayori than ever before! You have all the time in the world to build the perfect relationship with our cinnamon bun as the star of the show. At the heart of the mod, we took a mental health based approach in line with the experiences Sayori had in the original game, so we can hopefully support people by offering a source of positivity, advice, and unconditional understanding.
 
-AlexanDDOS (Sprite compositor)
+Currently we have a whole range of unique dialogue, questions, and games for you and Sayori to enjoy, and we have so many more ideas for the near future! We're very active around the mod and on our discord server and we promise to deliver frequent updates and announcements so there's always something new and exciting to do! 
+Why not get creative and try to add a feature or two yourself? (I'm sure she'd love that!)
 
-## Misc Arts & Edits:
+---
 
-AlexanDDOS (Sprite edits)
+## Compatability notice
 
-Team Salvato artists (original sprites)
+This mod is designed for use with a copy of the original game by Team Salvato, available at from the [official website](https://ddlc.moe).
 
-Lucian Pavel (Santa hat original model, excluded from the stable version)
+*Please note that we do **not** officially support installations using mod management software, nor do we support installations from sources other than our official GitHub. DDLC+ is not supported.*
 
-## Writers (without proofreading and translation):
+---
 
-AlexanDDOS
+## Installation
 
-Orcaramelo
+*Use these instructions if you haven't played Forever and Ever before.*
 
-Venus
+**Read the instructions carefully.**
 
-## Proofreaders:
+1. Download a fresh copy of DDLC from the [official site](https://ddlc.moe). **Do not use a Steam installation**.
+2. Extract/unzip DDLC.
+3. Download the latest release [here](https://github.com/ForeverAndEverTeam/fae-mod/releases): select the ZIP file starting with `Forever.Ever` (I.E `Forever.Ever.V0.1.0.New.Beginnings.zip`). **Do not download the source code, as this will result in future updates failing.**
+4. Extract/unzip the FAE mod files.
+5. Copy everything in the FAE mod files to the DDLC folder. If asked to replace files, select _Yes_.
+6. Delete `scripts.rpa` in the `game` folder of the DDLC folder.
+7. Finally, launch `Forever&Ever.exe` if you are on Windows, or `Forever&Ever.sh` if you are on Linux.
 
-tberriman
+---
 
-vermicellibug
+## Updating
 
-Atlas
+*Use these instructions if you already have Forever and Ever installed.*
 
-## Translators:
+**Read the instructions carefully.**
 
-AlexanDDOS (Russian, Esperanto & Toki Pona (WIP))
+1. Stop Forever and Ever, if you are currently playing the mod.
+2. **Back up your persistent**.
+3. Download the latest release [here](https://github.com/ForeverAndEverTeam/fae-mod/releases): select the ZIP file starting with `Forever.Ever` (I.E `Forever.Ever.V0.1.0.New.Beginnings.zip`). **Do not download the source code, as this will result in future updates failing.**
+4. Extract/unzip the FAE release files.
+5. Copy everything in the FAE release files to the DDLC folder. If asked to replace files, select _Yes_.
+6. Finally, launch `Forever&Ever.exe` if you are on Windows, or `Forever&Ever.sh` if you are on Linux.
 
-Vova Petelin (Russian)
-ElReyZero (Spanish)
+---
 
-littlebin (Chinese)
+## Bugs and feedback
 
-## SFX:
+To report bugs, request support or provide input with/to the mod, please raise a new issue [here](https://github.com/ForeverAndEverTeam/fae-mod/issues).
 
-Pipe98x (drawing cross)
+---
 
-sirrealist2 (drawing circle/line)
+# Brought to you by
 
-## Testers & Platinum Troubleshooters:
+## Current contributors
 
-AlexanDDOS
+_Bottling up those happy thoughts!_
 
-Leon9023 (Reddit, VK)
+- [Orcaramelo](https://github.com/Orcaramelo): Project Lead, Lead Artist, Writer
+- [Nathan](https://github.com/TRIDENT1313): Lead Developer, Writer
+- Sayori: Lead Writer, Musician
+- [Emilia/Monika (EYLO)](https://www.reddit.com/u/EmiliaMonika?utm_medium=android_app&utm_source=share): Writer
 
-Evgeny Zotov
+## Previous contributors
 
-littlebin
+_Thank you for your help in bringing FaE to life - we wouldn't be here without you!_
 
-MarioXenobladefan614
+- [Otter](https://github.com/my-otter-self): Writer
+- [Nemu-sus](https://github.com/Nemu-sus): Artist
+- [NekoLaiS](https://github.com/NekoLaiS): Programmer
+- Sobbcat: Writer
+- SlightlyAmiss: Musician
+- [AlexanDDOS](https://github.com/AlexanDDOS): Project Lead, Lead Developer, Writer, Tester
+- ElReyZero: Programmer
+- Venus: Writer
+- tberriman: Proofreader
+- vermicellibug: Proofreader
+- Atlas: Proofreader
+- Lucian Pavel: Artist
+- Vova Petelin: Translator (Russian)
+- ElReyZero: Translator (Spanish)
+- littlebin: Translator (Chinese), Tester
+- Leon9023: Tester
+- Evgeny Zotov: Tester
+- MarioXenobladefan614: Tester
 
-</details>
+## Special thanks
 
-<details>
-  <summary>License & Copyright</summary>
-
-See "LICENSE" for license information
+- [Monika After Story Team](https://github.com/Monika-After-Story/MonikaModDev)
+  - Adapted source code and systems used with permission
+  - Weather assets used with permission
+  - Ongoing support
+- [Just Natsuki Team](https://github.com/Just-Natsuki-Team/NatsukiModDev)
+  - Adapted source code and systems used with permission
+  - Weather assets used with permission
+  - Ongoing support
+- [multimokia](https://github.com/multimokia): Night theme (_Slepyori_)
+- [/r/DDLCMods](reddit.com/r/ddlcmods/)
+- Pipe98x: SFX (drawing cross)
+- sirrealist2: SFX (drawing circle/line)
+- Fj0rd_: Prerelease Sayori spritework
+- **Our community, for your ongoing patience and support**
 
-Made in accordance with Team Salvato's IP Guidelines
+_You're all awesome!_
 
-Copyright (c) 2018-2022 Alexander Osipov and the other creators
+---
 
-</details>
+# Community
 
-### Community
-You can [follow us on twitter](https://twitter.com/JustSayoriDev) for game updates.
+Follow us on [Twitter!](https://twitter.com/JustSayoriDev)
 
-Feel free to join our discord server too:
+Interested in taking part in a growing community of Sayori fans just like you, or just a chat with the team?
 
- [![Discord](banner)](https://discord.gg/ZqfEddFKux)
+If so, then please consider joining us on [Discord](https://discord.gg/nUWzgVZ9WT): we'd love to see you there!

game/additional/game-handler.rpy

@@ -1,19 +1,6 @@
 default persistent._fae_game_db = dict()
 
 
-init -10 python in fae_games:
-    import store
-
-    def is_platform_good_for_chess():
-        import platform
-        import sys
-
-        if sys.maxsize > 2**32:
-            return platform.system() == 'Windows' or platform.system() == 'Linux' or platform.system() == 'Darwin'
-
-        else:
-            return platform.system() == 'Windows'
-
 init python in fae_games:
 
     import store
@@ -31,15 +18,12 @@ init python:
             self.available = True
 
         def __call__(self, *args, **kwargs):
-            #global justIsSitting
 
             if self.preparation:
                 self.preparation(self, *args, **kwargs)
-            #justIsSitting = False
+
             if self.label and not kwargs.get("restart"):
                 renpy.call_in_new_context(self.label)
 
         def set_state(self, value):
             self.state = value
-
-    #mg_list = [] #mini-game list

game/additional/mg_bnc.rpy

@@ -154,7 +154,7 @@ label mg_bnc_s_comment(state = -1, restart = False): #Sayori's comment. 0 = init
     elif state == 1: # Correct answer
         s abaacoa "You're right. It was {i}[bnc.guessed]{/i}!"
         s abaaaea "Let's play one more time."
-        $bnc(restart = True)
+        $ bnc(restart = True)
     elif state == -2: # If you try to guess past the amount you're allowed to guess
         s gbaaipa "OK, you win, {i}meanie{/i}!"
         s "I'm really annoyed right now..."