@@ -36,9 +36,12 @@ the love of her life, Sam.
36
36
- SwiftLint and SwiftFormat (used internally for code formatting)
37
37
- Xcode Command Line Tools
38
38
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.
42
45
43
46
From here, you can open the Shounin project in Godot through the project manager, or
44
47
you can invoke ` just edit-game ` to open the project directly in the editor.
@@ -114,6 +117,7 @@ Available recipes:
114
117
build-all-deps # Build all dependencies
115
118
build-dep LIB_FLAGS +DEPENDENCIES # Build a specified set of dependencies with some flags
116
119
build-swift-godot # Builds the SwiftGodot xcframework.
120
+ clean # Cleans alls dependencies, logs, etc.
117
121
clean-all-deps # Cleans all dependencies
118
122
clean-dep +DEPENDENCIES # Cleans a specified set of dependencies
119
123
clean-logs # Cleans all logs built from a Just command.
@@ -124,16 +128,20 @@ Available recipes:
124
128
edit-game # Open Godot editor
125
129
edit-just # Edits this Justfile
126
130
fetch-remote-deps # Fetches remote dependencies from Git submodules
131
+ fetch-tools # Fetches the marteau toolchain
127
132
format-all-deps # Formats source files in all dependencies
128
133
format-dep +DEPENDENCIES # Formats the source files in a specified set of dependencies
129
134
lint # Runs SwiftLint on library code
130
135
test-all-deps # Test all dependencies
131
136
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
133
139
```
134
140
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 .
137
145
138
146
## Found an issue?
139
147
0 commit comments