Skip to content

Commit

Permalink
add scripts for stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
oatmealine committed Sep 25, 2022
1 parent a4b89d4 commit 88cd1e3
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 2 deletions.
5 changes: 4 additions & 1 deletion MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand All @@ -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?
Expand Down
2 changes: 2 additions & 0 deletions distribute-file.sh
Original file line number Diff line number Diff line change
@@ -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 changes: 2 additions & 0 deletions distribute-template.sh
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion template
Submodule template updated from 399d63 to 4e8ba2

0 comments on commit 88cd1e3

Please sign in to comment.