From d6ac1bccf150d2d7537cb68f1c8a2a7c1d8bc443 Mon Sep 17 00:00:00 2001 From: <> Date: Mon, 21 Oct 2024 10:21:56 +0000 Subject: [PATCH] Deployed 46b4663 with MkDocs version: 1.6.1 --- instructions/index.html | 15 +++++++++++---- search/search_index.json | 2 +- sitemap.xml.gz | Bin 127 -> 127 bytes 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/instructions/index.html b/instructions/index.html index 8efea11..ca55351 100644 --- a/instructions/index.html +++ b/instructions/index.html @@ -506,16 +506,23 @@
This program simplifies creating an advanced Prism Launcher CatPack.
This site hosts documentation on how to use this program. You can navigate using the sidebar.
Other useful links:
Want to help? Great! To get started, follow these steps. This guide assumes you know how to use Git on a basic level.
python -m venv venv
, then run venv\\scripts\\activate
to activate it.pip install -r requirements.txt
.We recommend the following when contributing:
autopep8
via pip install autopep8
to ensure you follow styling.The following page lists releases of this software.
This is here for archival purposes. When new versions are released, it may take a little bit before this table is updated.
"},{"location":"downloads/#catpack-crafter-v100","title":"CatPack Crafter v1.0.0","text":"Release notes: Initial release
Tag comparison
Prebuilt binaries:
Source code:
Using the app should be fairly simple, so hopefully this will be a walk in the park.
"},{"location":"instructions/#1-locate-your-images","title":"1. Locate your images","text":"It's a good idea to consolidate the images you will be using in a singular folder, or at least remember the path to get to them. Otherwise, you'll have take very long time trying to find the images you want.
"},{"location":"instructions/#2-using-the-app","title":"2. Using the app","text":"Assuming you have already downloaded the program, run it and you'll be presented with a couple of options.
CatPack Name
: The name of the CatPack, both in the JSON and the folder name. Be careful - if a folder with that name already exists and has a CatPack setup in it, the new JSON file will overwrite it.Select Output Folder
: Where the CatPack's folder will be located in.Select Default Image (Optional)
: Allows you to select an image that will be set as a \"default\", which means it wll show if no other image can be shown. The default image will be previewed at a smaller size beneath the options.Add Images
: Adds images to your CatPack. Each image will ask you for a Start and End date/month. Be cautious: the program does not have sanity checks for the calendar dates, so be sure not to accidentally input the 31st of Febuary (or something of that vein)!Confirm
: Creates the CatPack using the above options.Once your CatPack is created, you can move the folder with all the CatPack stuff into your Prism installation's catpacks
folder. This should be located at ../PrismLauncher/catpacks
, where ..
varies depending on the form of Prism you are using:
This page details how to run the program from source. If you have no idea what this page is saying, you probably shouldn't follow it.
"},{"location":"run-from-source/#setup","title":"Setup","text":"In order to build, you'll need the following as prerequisites:
requirements.txt
file for your convenience.python -m venv venv
, then using venv\\scripts\\activate
.Once you have the \"App\" category of dependencies installed, you can simply run python script.py
.
After installing dependencies in both the \"App\" and \"Compiling\" categories, you can run pyinstaller script.py
to compile. Some additional arguments you might want to use are:
--onefile
: Builds into a singular executable file.--name <name>
: Sets the executable output's name.--windowed
: Prevents CMD from coming up when you launch the executable.You only need to install the dependencies listed in the \"Documentation\" category. After that, you can simply run mkdocs build
, which will output a site/
folder that contains the fully built site.
Do NOT attempt to run mkdocs gh-deploy
, as it will create a new branch and (attempt to) push it to the remote.
This program simplifies creating an advanced Prism Launcher CatPack.
This site hosts documentation on how to use this program. You can navigate using the sidebar.
Other useful links:
Want to help? Great! To get started, follow these steps. This guide assumes you know how to use Git on a basic level.
python -m venv venv
, then run venv\\scripts\\activate
to activate it.pip install -r requirements.txt
.We recommend the following when contributing:
autopep8
via pip install autopep8
to ensure you follow styling.The following page lists releases of this software.
This is here for archival purposes. When new versions are released, it may take a little bit before this table is updated.
"},{"location":"downloads/#catpack-crafter-v100","title":"CatPack Crafter v1.0.0","text":"Release notes: Initial release
Tag comparison
Prebuilt binaries:
Source code:
Using the app should be fairly simple, so hopefully this will be a walk in the park.
"},{"location":"instructions/#1-locate-your-images","title":"1. Locate your images","text":"It's a good idea to consolidate the images you will be using in a singular folder, or at least remember the path to get to them. Otherwise, you'll have take very long time trying to find the images you want.
"},{"location":"instructions/#2-using-the-app","title":"2. Using the app","text":"Assuming you have already downloaded the program, run it and you'll be presented with a couple of options.
CatPack Name
: The name of the CatPack, both in the JSON and the folder name. Be careful - if a folder with that name already exists and has a CatPack setup in it, the new JSON file will overwrite it.Select Output Folder
: Where the CatPack's folder will be located in.Select Default Image (Optional)
: Allows you to select an image that will be set as a \"default\", which means it wll show if no other image can be shown. The default image will be previewed at a smaller size beneath the options.Add Images
: Adds images to your CatPack. Each image will ask you for a Start and End date/month. Be cautious: the program does not have sanity checks for the calendar dates, so be sure not to accidentally input the 31st of Febuary (or something of that vein)!Confirm
: Creates the CatPack using the above options.Once your CatPack is created, you can move the folder with all the CatPack stuff into your Prism installation's catpacks
folder. This should be located at ../PrismLauncher/catpacks
, where ..
varies depending on the form of Prism you are using:
This page details how to run the program from source. If you have no idea what this page is saying, you probably shouldn't follow it.
"},{"location":"run-from-source/#setup","title":"Setup","text":"In order to build, you'll need the following as prerequisites:
requirements.txt
file for your convenience.python -m venv venv
, then using venv\\scripts\\activate
.Once you have the \"App\" category of dependencies installed, you can simply run python script.py
.
After installing dependencies in both the \"App\" and \"Compiling\" categories, you can run pyinstaller script.py
to compile. Some additional arguments you might want to use are:
--onefile
: Builds into a singular executable file.--name <name>
: Sets the executable output's name.--windowed
: Prevents CMD from coming up when you launch the executable.You only need to install the dependencies listed in the \"Documentation\" category. After that, you can simply run mkdocs build
, which will output a site/
folder that contains the fully built site.
Do NOT attempt to run mkdocs gh-deploy
, as it will create a new branch and (attempt to) push it to the remote.