lucent/SharpCreditsCrediter
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity

update license + readme

Browse source
This commit is contained in:
Lucent 2023-10-27 22:50:05 +02:00
parent 269514038c
commit c45fe707d2
2 changed files with 44 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
LICENSE.txt
View file

@ -1,6 +1,7 @@
MIT License
Copyright (c) [year] [fullname]
Copyright (c) 2021 ConConner
Copyright (c) 2023 Lucent
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

43
README.md
View file

@ -1 +1,42 @@
# SharpCreditsCrediter
# SharpCreditsCrediter
Heavily inspired by [ConConner's CreditsCrediter](https://github.com/ConConner/ConCon-s-CreditsCrediter), rewritten in C# (targeting .NET 6.0).
The functionality is pretty much the same as ConConner's software, so the guide is pretty much the same, albeit with some additional/missing features.
## How to use
With this tool you can easily edit the credits of Metroid: Zero Mission and Fusion, without a HEX editor. All can be done through a .txt file and the program.
1. Load a Metroid: Zero Mission or Fusion ROM with the "Load ROM" button. Make sure to not have edited the game code (AMTE or BMXE), since the software relies on it to identify the game.
2. If you dont have a credits file yet you can extract the credits from the currently opened ROM with the "Extract" button. You can then select a name and saving location for said credits file.
3. Edit the existing credits file to your custom credits. There are a few rules for the credit files though which have to be followed.
Every new line starts with a one byte line marker (00, 01, 0A...). Each of these values has a different influence on the text following the marker. A list of all the markers is visible in the program and at the end of this file
Every line of text has a limit of 35 characters. Depending on the text size not all of them will be visible In-Game or will result in glitches so some experimentation might be needed. The program will cut off anything longer than 35 characters per line.
While you can end the credits at any point with the dedicated marker (06) there is a hard limit on how the credits can be. If your file is longer than this limit the program won't trigger a failsave and will result in glitches.
4. When you have your complete credits file, select "Import" and then the credits file. After that you are prompted to save a modfied version of your ROM, with the new credits applied.
5. DONE! Your new ROM should now have the custom credits applied!
-----------------------------
Line Markers:
* 00 - small, blue text
* 01 - small, red text
* 02 - big, white text
* 03 - small, white text
* 05 - small line break
* 06 - end credits
* 0A - All rights, including
* 0B - the copyrights of Game,
* 0C - Scenario, Music and Program,
* 0D - reserved by NINTENDO.
-----------------------------