1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
%global _empty_manifest_terminate_build 0
Name: python-botw-flag-util
Version: 0.3.5
Release: 1
Summary: Game data and save game data flag utilities for LoZ:BotW
License: GNU Affero General Public License v3 or later (AGPLv3+)
URL: https://github.com/GingerAvalanche/botw_flag_util
Source0: https://mirrors.aliyun.com/pypi/web/packages/6c/13/b62aa1d5991aa522a70d189cf1bd7bf8cb0204300f17c59e3262d67f87d8/botw_flag_util-0.3.5.tar.gz
BuildArch: noarch
Requires: python3-bcml
Requires: python3-oead
%description
# Breath of the Wild Flag Utilities
Game data and save game data flag utilities for LoZ:BotW
## Dependencies
* A dumped copy of Legend of Zelda: Breath of the Wild (for Wii U or Switch)
* Python 3.7+ (64-bit, added to system PATH)
The following `pip` packages, which will be automatically installed:
* bcml
* oead
## Setup
1. Download and install Python 3.7+, 64-bit. You must choose the "Add to System PATH" option during installation.
2. Open a command line and run `pip install botw_flag_util`
### How to Use
#### Generate flags:
`botw_flag_util generate [path_to_mod_root] [-a] [-r # #] [-b] [-v]`
* `path_to_mod_root` - The path to the root folder of your mod, which contains the `content` folder. Required.
* `-a` - Generate actor flags.
* `-r # #` - Generate revival flags. The first number is the ResetType for MainField actors. The second is the ResetType for CDungeon (shrine) actors. If one of them is set to -1, it will skip flag generation for that field type.
* `-b` - Use big-endian mode. For generating flags for Wii U.
* `-v` - Use verbose mode. Will give more verbose after-action report.
#### Find flags:
`botw_flag_util find [path_to_mod_root] [search_name] [-b] [-v]`
* `path_to_mod_root` - The path to the root folder of your mod, which contains the `content` folder. Required.
* `search_name` - The name of the flag to search for. Will find all flags whose DataName contains `search_name`. For example, `MainField_Npc_HiddenKorok` will find all Korok NPC flags.
* `-b` - Use big-endian mode. For deleting flags for Wii U.
* `-v` - Use verbose mode. Will give more verbose after-action report.
Once the search has been completed, you will be told how many game data and save data flags were found that matched `search_name`. You will then be given three choices:
* `v` - View more detailed information on the flags found: their full names and their types, and then prompt for another choice.
* `d` - Delete all the flags that were found by this search, and then return to the command line.
* `x` - Return to the command line.
##### Quirks
* `botw_flag_util` does not need a Bootup.pack present in your mod to do its thing. If one is not present, it will copy it from your game dump into your mod files and then edit that copy.
* A new copy of gamedata.ssarc and savedataformat.ssarc will always be written to Bootup.pack, even if no changes were made. This is done so that any invalid flags (e.g. duplicate flags) will be deleted from them. Invalid flags will cause BOTW to perform abnormally. This feature was included by request, and should never harm anything, but if you notice that your Bootup.pack's modified date has changed after no changes were made, this is why.
* Knowing which flags to give what properties is a very complicated affair. Rather than try to retrieve all that information from the data files, a stopgap has been developed: inside the `data` folder, where `botw_flag_util` is installed, is a file called `overrides.json`. In this file is a comprehensive set of override conditions. If you have come across any flags that you notice are receiving incorrect values, you may place the flag name inside the dictionary for the correspond flag type/property and give it a value. Any flags with that name as part of their name will receive that value for that property, overriding whatever standard logic applies to that flag during the generation process. For example, inside OVERRIDE_IS_ONE_SAVE is the name/value `"IsGet_": true`. This means that all flags with `IsGet_` in the name will have their `IsSave` property set to `true`. You can modify this file whenever you want, and as long as it is valid JSON and the values are valid for the properties they're being inserted into, the values will be properly overridden. `If you use this feature to create a more comprehensive ruleset for flag generation, please consider opening a PR on GitHub so that others may benefit from it as well.`
## Contributing
* Issues: https://github.com/GingerAvalanche/botw_flag_util/issues
* Source: https://github.com/GingerAvalanche/botw_flag_util
This software is in early, but usable, beta. There are several variable types that are not yet handled, and several cases that are not handled for the variable types that are handled. Feel free to contribute in any way.
## License
This software is licensed under the terms of the GNU Affero General Public License, version 3+. The source is publicly available on Github.
%package -n python3-botw-flag-util
Summary: Game data and save game data flag utilities for LoZ:BotW
Provides: python-botw-flag-util
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-botw-flag-util
# Breath of the Wild Flag Utilities
Game data and save game data flag utilities for LoZ:BotW
## Dependencies
* A dumped copy of Legend of Zelda: Breath of the Wild (for Wii U or Switch)
* Python 3.7+ (64-bit, added to system PATH)
The following `pip` packages, which will be automatically installed:
* bcml
* oead
## Setup
1. Download and install Python 3.7+, 64-bit. You must choose the "Add to System PATH" option during installation.
2. Open a command line and run `pip install botw_flag_util`
### How to Use
#### Generate flags:
`botw_flag_util generate [path_to_mod_root] [-a] [-r # #] [-b] [-v]`
* `path_to_mod_root` - The path to the root folder of your mod, which contains the `content` folder. Required.
* `-a` - Generate actor flags.
* `-r # #` - Generate revival flags. The first number is the ResetType for MainField actors. The second is the ResetType for CDungeon (shrine) actors. If one of them is set to -1, it will skip flag generation for that field type.
* `-b` - Use big-endian mode. For generating flags for Wii U.
* `-v` - Use verbose mode. Will give more verbose after-action report.
#### Find flags:
`botw_flag_util find [path_to_mod_root] [search_name] [-b] [-v]`
* `path_to_mod_root` - The path to the root folder of your mod, which contains the `content` folder. Required.
* `search_name` - The name of the flag to search for. Will find all flags whose DataName contains `search_name`. For example, `MainField_Npc_HiddenKorok` will find all Korok NPC flags.
* `-b` - Use big-endian mode. For deleting flags for Wii U.
* `-v` - Use verbose mode. Will give more verbose after-action report.
Once the search has been completed, you will be told how many game data and save data flags were found that matched `search_name`. You will then be given three choices:
* `v` - View more detailed information on the flags found: their full names and their types, and then prompt for another choice.
* `d` - Delete all the flags that were found by this search, and then return to the command line.
* `x` - Return to the command line.
##### Quirks
* `botw_flag_util` does not need a Bootup.pack present in your mod to do its thing. If one is not present, it will copy it from your game dump into your mod files and then edit that copy.
* A new copy of gamedata.ssarc and savedataformat.ssarc will always be written to Bootup.pack, even if no changes were made. This is done so that any invalid flags (e.g. duplicate flags) will be deleted from them. Invalid flags will cause BOTW to perform abnormally. This feature was included by request, and should never harm anything, but if you notice that your Bootup.pack's modified date has changed after no changes were made, this is why.
* Knowing which flags to give what properties is a very complicated affair. Rather than try to retrieve all that information from the data files, a stopgap has been developed: inside the `data` folder, where `botw_flag_util` is installed, is a file called `overrides.json`. In this file is a comprehensive set of override conditions. If you have come across any flags that you notice are receiving incorrect values, you may place the flag name inside the dictionary for the correspond flag type/property and give it a value. Any flags with that name as part of their name will receive that value for that property, overriding whatever standard logic applies to that flag during the generation process. For example, inside OVERRIDE_IS_ONE_SAVE is the name/value `"IsGet_": true`. This means that all flags with `IsGet_` in the name will have their `IsSave` property set to `true`. You can modify this file whenever you want, and as long as it is valid JSON and the values are valid for the properties they're being inserted into, the values will be properly overridden. `If you use this feature to create a more comprehensive ruleset for flag generation, please consider opening a PR on GitHub so that others may benefit from it as well.`
## Contributing
* Issues: https://github.com/GingerAvalanche/botw_flag_util/issues
* Source: https://github.com/GingerAvalanche/botw_flag_util
This software is in early, but usable, beta. There are several variable types that are not yet handled, and several cases that are not handled for the variable types that are handled. Feel free to contribute in any way.
## License
This software is licensed under the terms of the GNU Affero General Public License, version 3+. The source is publicly available on Github.
%package help
Summary: Development documents and examples for botw-flag-util
Provides: python3-botw-flag-util-doc
%description help
# Breath of the Wild Flag Utilities
Game data and save game data flag utilities for LoZ:BotW
## Dependencies
* A dumped copy of Legend of Zelda: Breath of the Wild (for Wii U or Switch)
* Python 3.7+ (64-bit, added to system PATH)
The following `pip` packages, which will be automatically installed:
* bcml
* oead
## Setup
1. Download and install Python 3.7+, 64-bit. You must choose the "Add to System PATH" option during installation.
2. Open a command line and run `pip install botw_flag_util`
### How to Use
#### Generate flags:
`botw_flag_util generate [path_to_mod_root] [-a] [-r # #] [-b] [-v]`
* `path_to_mod_root` - The path to the root folder of your mod, which contains the `content` folder. Required.
* `-a` - Generate actor flags.
* `-r # #` - Generate revival flags. The first number is the ResetType for MainField actors. The second is the ResetType for CDungeon (shrine) actors. If one of them is set to -1, it will skip flag generation for that field type.
* `-b` - Use big-endian mode. For generating flags for Wii U.
* `-v` - Use verbose mode. Will give more verbose after-action report.
#### Find flags:
`botw_flag_util find [path_to_mod_root] [search_name] [-b] [-v]`
* `path_to_mod_root` - The path to the root folder of your mod, which contains the `content` folder. Required.
* `search_name` - The name of the flag to search for. Will find all flags whose DataName contains `search_name`. For example, `MainField_Npc_HiddenKorok` will find all Korok NPC flags.
* `-b` - Use big-endian mode. For deleting flags for Wii U.
* `-v` - Use verbose mode. Will give more verbose after-action report.
Once the search has been completed, you will be told how many game data and save data flags were found that matched `search_name`. You will then be given three choices:
* `v` - View more detailed information on the flags found: their full names and their types, and then prompt for another choice.
* `d` - Delete all the flags that were found by this search, and then return to the command line.
* `x` - Return to the command line.
##### Quirks
* `botw_flag_util` does not need a Bootup.pack present in your mod to do its thing. If one is not present, it will copy it from your game dump into your mod files and then edit that copy.
* A new copy of gamedata.ssarc and savedataformat.ssarc will always be written to Bootup.pack, even if no changes were made. This is done so that any invalid flags (e.g. duplicate flags) will be deleted from them. Invalid flags will cause BOTW to perform abnormally. This feature was included by request, and should never harm anything, but if you notice that your Bootup.pack's modified date has changed after no changes were made, this is why.
* Knowing which flags to give what properties is a very complicated affair. Rather than try to retrieve all that information from the data files, a stopgap has been developed: inside the `data` folder, where `botw_flag_util` is installed, is a file called `overrides.json`. In this file is a comprehensive set of override conditions. If you have come across any flags that you notice are receiving incorrect values, you may place the flag name inside the dictionary for the correspond flag type/property and give it a value. Any flags with that name as part of their name will receive that value for that property, overriding whatever standard logic applies to that flag during the generation process. For example, inside OVERRIDE_IS_ONE_SAVE is the name/value `"IsGet_": true`. This means that all flags with `IsGet_` in the name will have their `IsSave` property set to `true`. You can modify this file whenever you want, and as long as it is valid JSON and the values are valid for the properties they're being inserted into, the values will be properly overridden. `If you use this feature to create a more comprehensive ruleset for flag generation, please consider opening a PR on GitHub so that others may benefit from it as well.`
## Contributing
* Issues: https://github.com/GingerAvalanche/botw_flag_util/issues
* Source: https://github.com/GingerAvalanche/botw_flag_util
This software is in early, but usable, beta. There are several variable types that are not yet handled, and several cases that are not handled for the variable types that are handled. Feel free to contribute in any way.
## License
This software is licensed under the terms of the GNU Affero General Public License, version 3+. The source is publicly available on Github.
%prep
%autosetup -n botw_flag_util-0.3.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-botw-flag-util -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri Jun 09 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.5-1
- Package Spec generated
|
