From dd8939b0c3cc6a02fee5883376774fba2bf5a4ab Mon Sep 17 00:00:00 2001 From: Ada Werefox Date: Wed, 27 Mar 2024 11:26:55 -0500 Subject: [PATCH] Slight update to README, added instructions in the tracker on how to set up and use it. Updated requirements.txt. --- README.md | 6 +- tunictracker/requirements.txt | 31 +++++++ .../templates/tracker/howto/index.html | 82 +++++++++++++++++++ .../tracker/templates/tracker/index.html | 4 +- 4 files changed, 116 insertions(+), 7 deletions(-) create mode 100644 tunictracker/requirements.txt create mode 100644 tunictracker/tracker/templates/tracker/howto/index.html diff --git a/README.md b/README.md index 4ead242..f0d955b 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ I think we can do better with Tunic tracking so I'm gonna make something and if ## Requirements -You'll need `python` and `npm` to use this for now, so make sure you have those installed. +You'll need `python` and `npm` to run this for now, so make sure you have those installed. ## Setup @@ -36,9 +36,7 @@ Install necessary modules with: `pip install -r requirements.txt` -Consider making a venv for this. - -`python -m venv "./.venv"` +Note: Consider making a venv for this - `python -m venv "./.venv"` Install the node modules with: diff --git a/tunictracker/requirements.txt b/tunictracker/requirements.txt new file mode 100644 index 0000000..964581e --- /dev/null +++ b/tunictracker/requirements.txt @@ -0,0 +1,31 @@ +asgiref==3.7.2 +autopep8==2.0.4 +certifi==2024.2.2 +charset-normalizer==3.3.2 +click==8.1.7 +colorama==0.4.6 +cssbeautifier==1.15.1 +Django==5.0.3 +django-browser-reload==1.12.1 +django-tailwind==3.8.0 +djlint==1.34.1 +EditorConfig==0.12.4 +gunicorn==21.2.0 +html-tag-names==0.1.2 +html-void-elements==0.1.0 +idna==3.6 +jsbeautifier==1.15.1 +json5==0.9.22 +numpy==1.26.4 +packaging==23.2 +pathspec==0.12.1 +pyarrow==15.0.1 +pycodestyle==2.11.1 +pylance==0.10.2 +PyYAML==6.0.1 +regex==2023.12.25 +requests==2.31.0 +six==1.16.0 +sqlparse==0.4.4 +tqdm==4.66.2 +urllib3==2.2.1 diff --git a/tunictracker/tracker/templates/tracker/howto/index.html b/tunictracker/tracker/templates/tracker/howto/index.html new file mode 100644 index 0000000..75778bc --- /dev/null +++ b/tunictracker/tracker/templates/tracker/howto/index.html @@ -0,0 +1,82 @@ +
+ How To Use This Tracker +
+
Setup
+ +
Usage
+ +
+
+
  • + * Since tunic doesn't save when you do a code, it won't update until you do something that causes the game to make a new save, like pausing, going to another area, or clearing a check. +
    • +
  • + ** Ideally, this would eventually be something more straightforward, like simply listing the path to an area. That will hopefully be added later down the line. +
    • +
    +
    diff --git a/tunictracker/tracker/templates/tracker/index.html b/tunictracker/tracker/templates/tracker/index.html index 51ef232..d3e5d88 100644 --- a/tunictracker/tracker/templates/tracker/index.html +++ b/tunictracker/tracker/templates/tracker/index.html @@ -18,14 +18,12 @@ alt="A trans pride fox emoji." width="" height="" /> - {% comment %} - A trans pride fox emoji. - {% endcomment %}
    (Tunic Transition Tracker)
    + {% include "tracker/howto/index.html" %}