Giter VIP home page Giter VIP logo

windwakertexteditor's Introduction

This project is defunct. Please see Winditor for an updated text editor.

Wind Waker Text Editor

Program image

A text editor for The Legend of Zelda: The Wind Waker.

Features

Searching

Messages can be searched by one of the three methods outined below.

Text Search

Typing the desired search term into the search box will filter the messages in the message panel so that only those that contain the term are displayed. For example, typing in "Orca" will show only the messages that contain the string "Orca".

Message ID Search

The Wind Waker assigns unique IDs to each message for use in the games' engines. Typing the string "msgid:" followed by the desired message ID will display the message with that ID, if it exists, in the message panel. For example, "msgid:10" will search for a message with the ID 10.

Item ID Search

Messages displayed when obtaining an item show the item's image in the textbox. The image to display is determined by the item ID specified in the message's textbox settings. Typing the string "itemid:" followed by the desired item ID will display only the messages that use that ID in the message panel. For example, in The Wind Waker, "itemid:80" will display only the messages with an item ID of 80, which is the Empty Bottle.

Adding and Deleting Messages

With this tool, messages may be added to or deleted from the list at will, and each new message will be given a unique message ID for use in-game. This is useful when using custom text with signs or other objects that call text by ID.

Textbox Types

The Wind Waker has several types of textboxes. They are described below.

Dialog

Normal textbox

The dialog textbox displays text over a translucent black box. It is used when someone is speaking.

Wood

Wood textbox

This textbox displays the text over a wooden texture. It is used for text written on wooden signs.

Stone

Stone textbox

This textbox displays the text over a stone texture. It is used for text written on stone objects.

Parchment

Parchment textbox

This textbox displays the text over a paper texture. It is used for the text written on paper, such as letters or Sturgeon's tutorial lessons.

Item Get

Item Get textbox

This textbox type displays the text over a translucent blue background, with an item image on the left side. It is used to describe an item that the player has just obtained. The item whose image is displayed is determined by the Item ID field in the textbox options.

Special

Special textbox

This textbox is similar to the Item Get type above, except for the fact that it doesn't have an item image in it. It is used for narration and status updates - such as when Forest Water expires and returns to being normal water.

Hint

Hint textbox

This type is used for hints given to the player by either Tetra or the King of Red Lions through the Pirate's Charm. It appears to be the same as the normal textbox, but it may have certain behaviors that distinguish it.

Centered Text

Centered textbox

This textbox automatically centers the text within it. Besides this, it is the same as the dialog textbox.

Wind Waker Song

Wind Waker Song textbox

This box is used for things involving the Wind Waker, such as displaying what song the player just conducted or the pattern to copy when learning a new song.

None

No textbox

This textbox type displays text with no box. Though it used during the prologue, it is glitchy when used in-game.

Textbox Positions

The textbox options include a field that determines at which predefined position on the screen the textbox draws. These values are described below.

Top 1

Top 1

This places the textbox at the top of the screen. The difference between Top 1 and Top 2 is unknown.

Top 2

Top 2

This places the textbox at the top of the screen. The difference between Top 1 and Top 2 is unknown.

Center

Center

This places the textbox at the center of the screen.

Bottom 1

Bottom 1

This places the textbox at the bottom of the screen. The differences between Bottom 1 and Bottom 2 are unknown.

Bottom 2

Bottom 2

This places the textbox at the bottom of the screen. The differences between Bottom 1 and Bottom 2 are unknown.

Control Tags

The games use binary codes throughout the text to modify it. When these codes are rendered in the editor, they are known as Control Tags, and are characterized by text bordered by two chevrons, < and >. Below is a list of these tags and what they do.

<color:x>

<color:x> changes the color of the text. X is the index of a color from the color bank to use. By default, in The Wind Waker, the unique colors and their indexes are:

Index Color
0 | White
1 | Red
2 | Green
3 | Blue
4 | Yellow
5 | Cyan
6 | Magenta
7 | Gray
8 | Orange

<icon:x>

<icon:x> displays the image specified by x in the textbox at the position of the Control Tag. These images are mainly restricted to things related to the controller (face buttons, control stick, C-stick, D-pad), but there are other images, including a heart icon and a music note.

<wait:x>

<wait:x> causes the text to stop drawing for x amount of time. The units that x represents are unknown.

<wait+dismiss:x>

<wait+dismiss:x> is usally used at the end of a textbox, and causes the box to wait for x amount of time before closing itself. The player cannot manually close the textbox before time is up.

<wait+dimiss (prompt):x>

<wait+dismiss (prompt):x> is similar to wait+dismiss:x. However, here the player is able to manually close the textbox before the specified amount of time has passed.

To-Do

  • Dumping of text and message settings to file
  • Search and Replace function
  • Text color editor
  • Highlighting of searched terms when using text search

windwakertexteditor's People

Contributors

sage-of-mirrors avatar

Stargazers

43trh avatar Joey Gallegos avatar  avatar  avatar paulloedu avatar TjVatio avatar  avatar  avatar

Watchers

James Cloos avatar  avatar  avatar  avatar  avatar TjVatio avatar  avatar

windwakertexteditor's Issues

Broken Cutscenes

There are some instances of cutscenes getting messed up because of this text editor. What i mean by messed up is that the wrong messege id gets assigned. The you got the Hero's tunic messege is replaced with part of the king of red lions introduction, the entire king of red lions intro cutscene is replaced with random messages mostly from the Anton and Linda sidequest, The ending cutscenes are using triforce piece item get messages as well as some random Windfall text.

Another issue is that the yes/no options seem to be broken for the camera messages as well as the memory card messages. The pause menu message for the Hero's charm is also broken. You can't select equip or don't equip, instead it acts like a normal textbox that always equips the mask.
The issue with this seems to lie with the editor not being able to save the yes and no button commands. The messages i mentioned uses other commands than those of the normal yes and no options. The tags show up properly when you open an unedited version of bmgres.arc but if you make any saves to the textfile whatsoever the tag goes away, even if you dont edit that specific message at all.

A few things broken

So I absolutely love this program. Makes what I am doing actually possible for me. Unfortunately, somehow the Auction house, new letter count, and letter count in the letter minigame are broken. And the program refuses to let me fix it. I have my version of the bmgres.arc and an unedited one for reference. I have tried to copy what it in the unedited one to fix the issue, but when I save and exit the program it reverts back to how it was. I think the issue is that it doesn't like the auction house commands in <>'s, as well as the letter and minigame commands that are also in <>'s. I would be beside myself with joy if you could perhaps fix these issues. Thanks for taking the time to read this.

App crash when save [kernelbase.dll]

I've clone and compile the master branch, the exe loads the .arc file and display all text without a problem, but when you prompt to save or save as.. crash with the kernelbase.dll error.

i did some google search and found this referring there's some exception not catching and that's why app crashes :(

windows 7 x86
msbuild 15.0

Maybe i compiled it wrong?
Can you give a shot to fix this?

Thank you for this helpful program!

2018-08-20 21_08_54-

Four Swords Adventures/+ Support [JPN]

Hi, would you possibly be interested in adding support for the BMG files in the japanese version of Four Swords Adventures? I'm working on a translation for the Navi Trackers mode. I've managed to dump the complete script with Cartographer (at least it appears that it's complete), but Atlas won't insert it properly, so that's off the table. Then I stumbled upon your project and saw how easy it makes editing Wind Waker's bmg files. :)

The bmg files in FSA appear to be slightly different than the Wind Waker ones, but it is well documented here -
http://wiki.tockdom.com/wiki/BMG_(File_Format)

Here's the BMG that has all the text for the Navi Trackers mode if you're interested-
https://drive.google.com/open?id=1DTlD6tvI_S3N-acagJ3LvwuwKfphOCVJ

Anyways, just thought I would ask. I apologize for making an issue for this, but I had no other way of contacting you. I can be reached at [myusername]@gmail.com if you so desire :)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.