From 153ed863acaab8b0ec75ae777f92b8498b2180b3 Mon Sep 17 00:00:00 2001 From: Phil Bajsicki Date: Fri, 25 Aug 2023 16:17:33 +0200 Subject: [PATCH] Added a new idea for the process (bottom of file). --- README.org | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.org b/README.org index a324f48..ba71a59 100644 --- a/README.org +++ b/README.org @@ -2,7 +2,7 @@ #+author: Phil Bajsicki #+PROPERTY: header-args :tangle fra.py * 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: @@ -78,7 +78,7 @@ The output of this is an org-mode file in the following pattern: * 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. @@ -88,7 +88,7 @@ There is a rough overview of the structure: #+begin_example ,#+name: Name of the following source block. -,#+begin_src python :tangle file.name +,#+begin_src lang :tangle file.name [code goes here] ,#+end_src #+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. * 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 ** Credits: The following are mods from which .csv files have been generated. The recipe .csv files are included in the ~mod-recipes~ directory.