diff --git a/README.md b/README.md index 5b57eb2f..a30fd7fb 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,108 @@ -![# Witch Trainer: Silver](https://1.bp.blogspot.com/--t9cxuok8JU/YUurd9fYbLI/AAAAAAAAABc/EbEFemd0TxUXoiQVeDArIY7hmCQPVw1jACNcBGAsYHQ/w400-h278/title.png) + +
+ + Logo + -This repository contains all of the game's source code. If you are searching for the most recent stable build, please [visit our website's download page](https://www.silverstudiogames.org/p/download.html) instead. +

+ A complete repository for more than just Hermione's backend. +
+ Explore the wiki » +
+
+ FAQ + · + Report Bug + · + Request Feature +

+
-The development takes place on the `dev` branch, and occasionally on feature branches, `main` branch is reserved for game releases. + +## Getting Started -# Developers: -Johnny28, LoafyLemon, Boppin +* **`dev`:** Active development occurs primarily on this branch, and occasionally on feature branches. +* **`current`:** This branch is dedicated to patches for the current public version. +* **`main`:** The main branch is exclusively for finalized game releases. -# Contributors: -MaiL, Mo, UE CatBug, Lineup, Soggy, Asease1, Linear, Lupin, Techy, Dr. Noodle, MadMerlin, DostojevskijSTG, STG Artguy, Crew, Ven, perniciousducks, Cleanzo, Darwin7, Pinguino, Sandmaster, Amadan, Heretic, Maverick, Anon, MedicBear, TropeCode, Booom313, CaptainNemo, and anonymous. +## Prerequisites -# Requirements: -* Renpy 7.5+ -* Python 2.7 +
+ Windows +
    +
  1. Download and install Ren'py SDK
  2. +
  3. Download and install git
  4. +
+
-# Documentation -TBD +
+ Debian -# Translating -TBD +### Install Ren'Py SDK +
curl -o renpy-sdk.tar.bz2 https://www.renpy.org/dl/8.1.1/renpy-8.1.1-sdk.tar.bz2
+tar -xjf renpy-sdk.tar.bz2
+mv renpy-8.1.1-sdk /opt/renpy
+chmod +x /opt/renpy/renpy.sh
+echo "alias renpy=/opt/renpy/renpy.sh" >> ~/.bashrc
+source ~/.bashrc
-# FAQ: +### Install GIT, GIT-LFS +
sudo apt install git git-lfs
+git lfs install
+ +
-#### Where can I support Witch Trainer: Silver? -You can support us on [patreon](https://www.patreon.com/SilverStudioGames). +## Installation -#### I have found a bug, how do I report it? -Please make a report on the [discord](https://discord.gg/UbQeTCJ5RW). +
+ Windows +
    +
  1. Clone the repository: +
    git clone https://dev.silverstudiogames.org/SilverStudioGames/WTS.git
    +
  2. +
  3. Run Ren'py Launcher.
  4. +
  5. Hit preferences and select the directory where the project is located.
  6. +
  7. Hit return and click on 'Launch Project'.
  8. +
+
-#### Can I receive access to the issue tracker? -Yes, upon review we may grant you access to the repository. Contact us on [discord](https://discord.gg/UbQeTCJ5RW) for details. +
+ Debian +
git clone https://dev.silverstudiogames.org/SilverStudioGames/WTS.git
+renpy WTS
+ +
-#### Can I make a pull request? -Bug fixes and enhancements are welcome, but content submissions must be thoroughly evaluated before they are accepted. +## Build -#### Why is the registration closed? -Our server resources are limited, we need to conserve them. We may re-open registration in the future. +
+ Windows +Navigate the GUI in Ren'Py launcher for packaging purposes. +
+
+ Debian +
renpy /opt/renpy/launcher distribute WTS --package pc
+
+ +## License +Source code distributed under the LGPL-3.0 license. See [LICENSE](LICENSE) for more information. + +## Active Developers: +- LoafyLemon - Lead Developer +- Johnny28 - Lead Writer +- Boppin - Lead Artist + +## Contributors: +- MaiL, Mo, UE CatBug, Lineup, Soggy, Asease1, Linear, Lupin, Techy, Dr. Noodle +- MadMerlin, DostojevskijSTG, STG Artguy, Crew, Ven, perniciousducks, Cleanzo, Darwin7 +- Pinguino, Sandmaster, Amadan, Heretic, Maverick, Anon, MedicBear, TropeCode, Booom313 +- CaptainNemo, NotTera, Armise, Cosmic and anonymous. + +
+ + Silver Studio Games logo +

Silver Studio Games

+
+
+ +

(back to top)