More documentation stuff

backup
LinuxMint4Ever 2019-10-06 23:10:51 +02:00
parent a8539a9984
commit 8fc8e88906
8 changed files with 23 additions and 4 deletions

View File

@ -19,6 +19,7 @@ The Launcher for my mod pack
* [ ] Create the launcher backend
# Documentation
Documentation for each individual file can be found in the same directory
## Directories
* __devtools__ contains development tools
* __lib__ contains libraries for Minecraft and the launcher

View File

@ -1,3 +1,4 @@
# Development tools
## Files:
* __fake_java.py__ can be used to get the command used to start Minecraft. When run, it will create a file called `fake_java_out.txt` in its working directory.
* __rmpyc__ removes all `.pyc` files in the current working directory and all subdirectories.

6
lib/README.md Normal file
View File

@ -0,0 +1,6 @@
# lib
This directory contains libraries, natives and runtimes used by the launcher and Minecraft.
## Directories
* __jar__ the libraries for minecraft (and the version jar...)
* __launcher__ everything used by the launcher
* __natives__ the natives for minecraft

View File

@ -3,5 +3,5 @@
This directory will contain all libraries Minecraft relies on.
As Minecraft itself is specified as a library for Forge on the command line, its version jar goes here as well.
Unfortunately, I cannot put them here for convenience due to copyright.
Unfortunately, I cannot put them here for convenience because of the existence of copyright.

5
lib/launcher/README.md Normal file
View File

@ -0,0 +1,5 @@
# lib/launcher
This directory contains the libraries and runtimes used by the launcher.
##Directories
* __java__ the Java components
* __python__ the python components

View File

@ -0,0 +1,3 @@
# lib/launcher/java
##Directories
* __runtime__ will contain a java runtime

View File

@ -1,5 +1,7 @@
# lib/launcher/python
##Directories:
* __runtime__ will contain a python runtime
## Files
* __gui.py__ will contain the GUI (Wow! Really?). The GUI will be accessed by `main.py`.
* __mchandler.py__ will be the launcher library. This time, it will not be a runnable hybrid library.
* __updater.py__ will be used for updating the mod pack and possibly the launcher as well.
@ -33,7 +35,7 @@
* [ ] optional launcher updates
* [ ] optional mod pack updates
* [ ] setup change updates (used to install/uninstall components)
* [ ] add initial mod pack install by applying a setup change update **->** main.py
* [ ] add initial mod pack install by applying a setup change update **** main.py
* __cfghandler.py__
* [ ] provide read and write functions for config values
* [ ] add a function to set the config file path

View File

@ -1,4 +1,5 @@
# res
This directory will contain the resources used by Minecraft.
__gather_assets.sh__ will conveniently place all your Minecraft assets here for you.
## Files
* __gather_assets.sh__ will conveniently place all your Minecraft assets here for you.