|
| 1 | +# MakeRPG |
| 2 | + |
| 3 | +MakeRPG is intended to be a system that allows anyone who can edit YAML files to make automatic characters and game systems. |
| 4 | + |
| 5 | +# Dependencies |
| 6 | + |
| 7 | +MakeRPG runs using Django 2.1 and Python 3. You can install those however you like, but here is an easy way. |
| 8 | + |
| 9 | +## Windows, Mac, or Linux |
| 10 | + |
| 11 | +1. [Install Anaconda](https://docs.anaconda.com/anaconda/install/) |
| 12 | +1. Open your new [Anaconda Navigator](https://docs.anaconda.com/anaconda/navigator/) and go to the Environments |
| 13 | +1. On the right, choose "Not installed" from the drop-down menu |
| 14 | +1. Type "django" into the "Search Packages" field |
| 15 | +1. Click the checkbox to the left of "django" in the table |
| 16 | +1. Click Apply in the bottom-right of the panel and it will install Django |
| 17 | + |
| 18 | +# Getting Set Up |
| 19 | + |
| 20 | +Getting set up can be easy too. It involves starting the MakeRPG Django server, configuring your server admin, and starting your server. |
| 21 | + |
| 22 | +## Steps |
| 23 | + |
| 24 | +1. Clone this repository |
| 25 | +1. Open your Anaconda prompt by clicking the "Play" button next to your "base (root)" environment where you installed Django in the Anaconda Navigator |
| 26 | +1. Select the "Open Terminal" option |
| 27 | +1. Change directory with `cd` on the terminal into the path on your computer where you cloned this repository |
| 28 | +1. Type the following: |
| 29 | +``` |
| 30 | +python manage.py createsuperuser |
| 31 | +``` |
| 32 | +1. You will be prompted for your Django server admin username, email address, and password |
| 33 | +1. Type the following three lines in sequence (type the line and then hit Enter): |
| 34 | +``` |
| 35 | +python manage.py makemigrations |
| 36 | +python manage.py migrate |
| 37 | +python manage.py runserver |
| 38 | +``` |
| 39 | + |
| 40 | +# Making Characters |
| 41 | + |
| 42 | +Now you are ready for the extra cool part, automatic character generation. It is currently achieved with a Python script called `setup.py`. You'll need to edit a few numbers in the `setup.py` script and then you'll be ready to start. |
| 43 | + |
| 44 | +## The first run of `setup.py` |
| 45 | + |
| 46 | +The first time you will need to have your YAML files ready and point the `setup.py` to the absolute paths to those files on your computer. You can make sample characters at the same time if you want, but don't have to. The important part is to only run `setup.py` once this way to initialize your database's history rolling and roles, stats, and skills. |
| 47 | + |
| 48 | +In another different terminal navigated to the same folder from the "Getting Set Up" section above, type: |
| 49 | + |
| 50 | +``` |
| 51 | +python setup.py |
| 52 | +``` |
| 53 | + |
| 54 | +It will print out a few messages about setting things up in your database. |
| 55 | + |
| 56 | +## From then on |
| 57 | + |
| 58 | +You need to open up the `setup.py` and comment out the two lines to only run once. You can choose to create any number of character by editing the `character_count` variable. Now every other time you will run `setup.py` the same way: |
| 59 | + |
| 60 | +``` |
| 61 | +python setup.py |
| 62 | +``` |
| 63 | + |
| 64 | +Now open a web browser and go to [`http://localhost:8000/cc/`](http://localhost:8000/cc/) to see all of your characters. |
| 65 | + |
| 66 | +Enjoy! |
0 commit comments