Skip to content

Commit 99ceff5

Browse files
committed
Switch from pipenv to poetry
Update old documentation to refer to Python 3.10 and poetry
1 parent d23ed8d commit 99ceff5

File tree

5 files changed

+773
-571
lines changed

5 files changed

+773
-571
lines changed

CONTRIBUTING.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,27 @@ If you're not a Python programmer, skip this section and read "Setup walkthrough
1313
* Obtain bot credentials from syntaxaire on Discord
1414
* Install Git and clone this repository
1515
* Download [the tiles zip](https://www.dropbox.com/s/3hub59uoiamz0vq/caves-of-qud-tiles-200.71.zip?dl=1) and extract it into the project directory so that the `Textures` directory is in the project directory.
16-
* If you don't have Python 3.8, install Python 3.8 from [Python.org](https://python.org/) and select the installer option to add it to your PATH. If on Ubuntu, follow the instructions below.
16+
* If you don't have Python 3.10, install Python 3.10 from [Python.org](https://python.org/) and select the installer option to add it to your PATH. If on Ubuntu, follow the instructions below.
1717
* In your terminal, `cd` to your copy of the repository and run these commands:
18-
For Windows users, with Python 3.8 installed and the options to 'Install launcher for all users' and 'Add Python 3.8 to PATH' having been selected in the installer:
18+
For Windows users, with Python 3.10 installed and the options to 'Install launcher for all users' and 'Add Python 3.10 to PATH' having been selected in the installer:
1919
```
20-
py -3 -m pip install pipenv
20+
py -3 -m pip install ppoetry
2121
cd (your qud-wiki source directory)
22-
py -3 -m pipenv sync --dev
23-
py -3 -m pipenv shell
22+
py -3 -m poetry install
2423
copy wiki.yml.example wiki.yml
2524
(edit wiki.yml to include bot credentials)
26-
python -m qbe
25+
poetry run python -m qbe
2726
```
2827

2928
For Ubuntu users:
3029
```
31-
sudo apt install python3.8 python3-pip libqt5gui5
32-
python3 -m pip install --user pipenv
30+
sudo apt install python3.10 python3-pip libqt5gui5
31+
python3 -m pip install --user poetry
3332
cd (your qud-wiki source directory)
34-
python3 -m pipenv sync --dev
35-
python3 -m pipenv shell
33+
python3 -m poetry install
3634
cp wiki.yml.example wiki.yml
3735
(edit wiki.yml to include bot credentials)
38-
python -m qbe
36+
poetry run python -m qbe
3937
```
4038

4139
## Setup walkthrough for Windows
@@ -53,7 +51,7 @@ Search it up on the app store of your choosing and install the program.
5351
* In the second, lower box it should now say where the repository is being put. Take note of this, as it will make things easier. Write it down, ideally somewhere you can copy and paste. This is called the "File Location" or project directory.
5452
* Click the blue button labeled "Clone".
5553

56-
3. Install Python 3.8, if you have not already.
54+
3. Install Python 3.10, if you have not already.
5755
* Go to Python.org and click on the "Downloads" section, then click on the operating system you are using.
5856
* If you are on Mac, download the most recent Mac OS 64-bit installer. If you are on Windows, download the most recent version of Python, choosing a "Windows x86-64 executable" installer.
5957
* Find Python in your downloads, and install it. MAKE SURE TO CHECK THE BOX TO ADD IT TO YOUR PATH! THIS IS VERY IMPORTANT.
@@ -64,22 +62,22 @@ Search it up on the app store of your choosing and install the program.
6462
* You should now be asked to select the files' destination. Type in the file location from earlier and press enter. This will take a while. When this is done, you should have a "Textures" folder in your project directory.
6563

6664
5. Bot credentials.
67-
* PM syntaxaire on Discord and ask for bot credentials. They might need your username on Fandom.com. The bot credentials are used because all bot edits are done from the same account which is marked as a bot.
65+
* PM syntaxaire on Discord and ask for bot credentials. They might need your username on wiki.cavesofqud.com. The bot credentials are used because all bot edits are done from the same account which is marked as a bot.
6866
* Copy `wiki.yml.example` to `wiki.yml` and edit it to include your own details.
6967

7068
6. Run the App
7169
* Open your terminal. On Mac you can look for an application called "Terminal" in your applications, on Windows you can search for "Command Prompt". Either way, start the app.
7270
* You should now be greeted with a black screen, perhaps with a bit of white text in it.
7371
* Type in `cd`, then a space, then write out the file location. Press enter (or return, for Mac users)
74-
* Type out `pip install pipenv`, press enter, and wait until your terminal stops doing things and you can type again.
75-
* Type out `pipenv sync`, press enter, and wait again.
76-
* Type out `pipenv run app` and hopefully, after printing some messages, Qud Blueprint Explorer should open for you. Note that if you close the terminal window, QBE will also close.
72+
* Type out `pip install poetry`, press enter, and wait until your terminal stops doing things and you can type again.
73+
* Type out `poetry install`, press enter, and wait again.
74+
* Type out `poetry run python -m qbe` and hopefully, after printing some messages, Qud Blueprint Explorer should open for you. Note that if you close the terminal window, QBE will also close.
7775
* The first screen asks you to locate the game root directory.
7876
The game root should be the folder containing the Caves of Qud executable and the `CoQ_Data` folder. On Steam this should be something like `Steam/steamapps/common/Caves of Qud/`
7977
which on Linux might be located in `~/.local/share/`,
8078
or on Mac OS might be located in `~/Library/Application Support/`.
8179

82-
When you want to open the app again, go to your terminal, type in "cd (File Location Here)", press enter, then type in "pipenv run app".
80+
When you want to open the app again, go to your terminal, type in "cd (File Location Here)", press enter, then type in "poetry run python -m qbe".
8381

8482
If this did not work, please send me a message on Discord. I am pokedragonboy, and would love to help you and make this guide better.
8583

Pipfile

-21
This file was deleted.

0 commit comments

Comments
 (0)