Skip to content

Commit 3fd3b85

Browse files
authored
Create README.md
1 parent bb82963 commit 3fd3b85

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Text editor for NES imagineering games, texts are compressed with Golomb 4 bits and this tool can handle that. Games mainly used:
2+
3+
- Barbie (USA).nes
4+
- Home Alone 2 - Lost in New York (USA).nes
5+
- Ren & Stimpy Show, The - Buckeroo$! (USA).nes
6+
- Simpsons, The - Bart vs. the Space Mutants (USA).nes
7+
- Simpsons, The - Bart vs. the World (USA).nes
8+
- Simpsons, The - Bartman Meets Radioactive Man (USA).nes
9+
10+
Also the games listed used 2 bytes pointers, this tool formats the list of pointers automatically.
11+
12+
## Usage
13+
14+
Description:
15+
16+
```
17+
Imagineering_golomb.py -d <romFile> <outFile> <tblFile>
18+
Imagineering_golomb.py -c <outFile> <romFile> <tblFile>
19+
Imagineering_golomb.py -v show version.
20+
```
21+
22+
The program doesn't handle many exceptions, so try to provide the correct information to avoid issues. For more information, read the attached readme.txt.
23+
24+
### Instrutions
25+
26+
The attached files and instruccions are for Barbie (USA).nes, but you can change it, I recommend using my settings in file game_config.txt
27+
28+
First copy all files in the same directory of the ROM, use "extract text.bat", it will a file script.bin, Then edit the text and graphics use encode.tbl file. Once you're done, simply open "insert text.bat" and it will automatically insert the text.
29+
30+
## Frecuency Answer Questions
31+
32+
### Can I use this tool in my personal project?
33+
34+
Of course, there's no need to ask. Feel free to use it in your project. I only ask that you mention me.

0 commit comments

Comments
 (0)