oat
/
uranium-template
Template
1
0
Fork 0
Code Issues Pull Requests Releases 5 Activity

add scripts for stuff

This commit is contained in:
Jill 2022-09-25 16:00:09 +03:00
parent a4b89d44b4
commit 88cd1e3a73
4 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
MANUAL.md
View File

@ -139,6 +139,7 @@ Uranium Template originally formed during the creation of a currently unreleased
Installation is the exact same as any other NotITG template:
0. Get the latest template version from [the Gitea releases page](https://git.oat.zone/oat/uranium-template/releases)
1. Unzip your installation zip, as you would a modfile
2. Edit `Song.sm` in your editor of choice (ArrowVortex, NotITG) to include necessary metadata; replace `silence.ogg` with an actual track, if necessary
3. Edit `main.lua` to do whatever you wish to do with it! The entirety of the `src/` folder is yours!
@ -148,11 +149,13 @@ Installation is the exact same as any other NotITG template:
After you're done with writing your file, be sure to take these steps to reduce the filesize and get your game ready for zipping up!
- Remove `MANUAL.md`, `jillo_png.png`, `docs/`, `.vscode/`, `.gitconfig`, `.gitignore` and `template/typings.lua`. These are files that aren't necessary outside of a development environment!
- Remove `MANUAL.md`, `docs/`, `.vscode/`, `.gitconfig`, `.gitignore` and `template/typings.lua`. These are files that aren't necessary outside of a development environment!
- Optionally, remove `Song.sm.auto` and `Song.sm.old`. These files may not exist depending on certain factors.
- If you've followed step 4 during [Installation](#installation), be sure to remove your typings folder (likely `.typings`)
- If you're using Git, **PLEASE REMOVE YOUR `.git/` FOLDER!!!**
If you're on Linux or have MSYS2/WSL/similar installed, you can use the [distribution script](distribute-file.sh).
Afterwards, it should be safe to zip everything up and send it over!
## How do I start writing code?

2
distribute-file.sh Executable file
View File

@ -0,0 +1,2 @@
#!/bin/bash
zip -9 -r package.zip --exclude="*.git*" --exclude="*.typings*" --exclude="*.vscode*" --exclude="*docs*" --exclude="*MANUAL.md" --exclude="*template/typings.lua*" --exclude="*.sm.auto*" --exclude="*.sm.old*" --exclude="*.sh*" .

2
distribute-template.sh Executable file
View File

@ -0,0 +1,2 @@
#!/bin/bash
zip -9 -r package-template.zip --exclude="*.git/*" --exclude="*template/.git*" --exclude="*.gitignore_local*" --exclude="*.gitmodules*" --exclude="*.typings*" --exclude="*template/docs*" --exclude="*README.md" --exclude="*.sm.auto*" --exclude="*.sm.old*" --exclude="*distribute-template.sh*" .

2
template

@ -1 +1 @@
Subproject commit 399d6329a0d2783ec112119e0c2d721169dcc6e3
Subproject commit 4e8ba205621df4df01643dc6eea181656fc23bf8