Skip to content

Commit e1a3e67

Browse files
📝 Update README.md
Includes instructions on unswizzling character assets before building the game as normal. Part of IOH-23, IOH-2, and IOH-3.
1 parent f15f223 commit e1a3e67

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,12 @@ the love of her life, Sam.
3636
- SwiftLint and SwiftFormat (used internally for code formatting)
3737
- Xcode Command Line Tools
3838

39-
Start by cloning the repository using `gh repo clone` or `git clone --recursive`.
40-
Then, run `just build-swift-godot` and `just build-all-deps` to build the required
41-
dependencies for the internal extensions that the main game uses.
39+
1. Start by cloning the repository using `gh repo clone` or `git clone --recursive`.
40+
2. Next, run `just fetch-tools` to fetch the other tools needed to build the game.
41+
3. Then, run `just build-swift-godot` and `just build-all-deps` to build the required
42+
dependencies for the internal extensions that the main game uses.
43+
4. Finally, run `just unswizzle-assets` to unswizzle the assets in the game's resources so
44+
that the game can be built normally.
4245

4346
From here, you can open the Shounin project in Godot through the project manager, or
4447
you can invoke `just edit-game` to open the project directly in the editor.
@@ -114,6 +117,7 @@ Available recipes:
114117
build-all-deps # Build all dependencies
115118
build-dep LIB_FLAGS +DEPENDENCIES # Build a specified set of dependencies with some flags
116119
build-swift-godot # Builds the SwiftGodot xcframework.
120+
clean # Cleans alls dependencies, logs, etc.
117121
clean-all-deps # Cleans all dependencies
118122
clean-dep +DEPENDENCIES # Cleans a specified set of dependencies
119123
clean-logs # Cleans all logs built from a Just command.
@@ -124,16 +128,20 @@ Available recipes:
124128
edit-game # Open Godot editor
125129
edit-just # Edits this Justfile
126130
fetch-remote-deps # Fetches remote dependencies from Git submodules
131+
fetch-tools # Fetches the marteau toolchain
127132
format-all-deps # Formats source files in all dependencies
128133
format-dep +DEPENDENCIES # Formats the source files in a specified set of dependencies
129134
lint # Runs SwiftLint on library code
130135
test-all-deps # Test all dependencies
131136
test-dep +DEPENDENCIES # Test a specified set of dependencies
132-
137+
test-game # Runs the integration tests through Godot.
138+
unswizzle-assets # Unswizzles protected images
133139
```
134140

135-
More information on how to install and use Marteau can be found on the source code
136-
repository for Marteau at https://github.com/Indexing-Your-Heart/marteau.
141+
> **Note**
142+
> To install Marteau from Homebrew automatically, run `just fetch-tools`. More information
143+
> use Marteau can be found on the source code repository for Marteau at
144+
> https://github.com/Indexing-Your-Heart/marteau.
137145
138146
## Found an issue?
139147

0 commit comments

Comments
 (0)