phil/factorio-recipe-analyzer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added a new idea for the process (bottom of file).

Browse source
This commit is contained in:
Phil Bajsicki 2023-08-25 16:17:33 +02:00
parent 23ae10b070
commit 153ed863ac
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.org
View file

@ -2,7 +2,7 @@
#+author: Phil Bajsicki #+author: Phil Bajsicki
#+PROPERTY: header-args :tangle fra.py #+PROPERTY: header-args :tangle fra.py
* Intro * Intro
This is a simple Python script which generates an analysis of each recipe into its component parts, and delivers insight into the balance and progression of a mod. This is a simple script which generates an analysis of each recipe into its component parts, and delivers insight into the balance and progression of a mod.
The .csv files used as input are generated in Factorio, by loading a new game with only ~base~ and your chosen mod enabled, and running the following Lua code: The .csv files used as input are generated in Factorio, by loading a new game with only ~base~ and your chosen mod enabled, and running the following Lua code:
@ -78,7 +78,7 @@ The output of this is an org-mode file in the following pattern:
* On the script * On the script
This is a literate script. The source code is embedded in these code blocks, and tangled into the Python script using org-babel. This allows me to write a description of what I want to do, and comment on it without resorting to ~// /* */~ ugly comments. This is a literate script. The source code is embedded in these code blocks, and tangled into the script using org-babel. This allows me to write a description of what I want to do, and comment on it without resorting to ~// /* */~ ugly comments.
Better yet, I can include [[Lua code generating a .csv file containing all recipes using the items in the whitelist.][links directly to places within the file]] and easily cross-reference what I'm doing with the documentation/ design. Better yet, I can include [[Lua code generating a .csv file containing all recipes using the items in the whitelist.][links directly to places within the file]] and easily cross-reference what I'm doing with the documentation/ design.
@ -88,7 +88,7 @@ There is a rough overview of the structure:
#+begin_example #+begin_example
,#+name: Name of the following source block. ,#+name: Name of the following source block.
,#+begin_src python :tangle file.name ,#+begin_src lang :tangle file.name
[code goes here] [code goes here]
,#+end_src ,#+end_src
#+end_example #+end_example
@ -104,7 +104,7 @@ The easiest way to generate outputs from here is to open this file in Emacs, and
*Important note:* the files in ~./mod-recipes~ are working files. They're not intrinsic parts of the software - they're there primarily for testing and development. *Important note:* the files in ~./mod-recipes~ are working files. They're not intrinsic parts of the software - they're there primarily for testing and development.
* License * License
I don't own the source csv files generated by Factorio, nor the mods the script is pulling from. The Python script itself is GPLv3, with the exception of third-party libraries licensed otherwise. I don't own the source csv files generated by Factorio, nor the mods the script is pulling from. This script itself is GPLv3, with the exception of third-party libraries licensed otherwise.
** TODO: include GPLv3 in the repo ** TODO: include GPLv3 in the repo
** Credits: ** Credits:
The following are mods from which .csv files have been generated. The recipe .csv files are included in the ~mod-recipes~ directory. The following are mods from which .csv files have been generated. The recipe .csv files are included in the ~mod-recipes~ directory.