TTR Pak

TTR Pak is designed to easily create and manage content packages for Toontown Rewritten. No command line experience, programming skills, or other software is needed.


Download

Download Click here for download. (3 MB)

Installation

Place the program "ttrpak.exe" and the accompanying "ttrpak" folder in your Toontown Rewritten installation folder. This is usually located at the following location:

C:\Program Files\Toontown Rewritten

If you try to start the program in the wrong location it will fail.

Note: TTR Pak requires Microsoft .NET Framework 4.0. As of right now this is only compatible with Windows. I appologize for the inconvienience.

Using the program

TTR Pak manages packages and projects. The top panel contains a list of packages, the bottom a list of projects. Projects can be compiled to packages and packages can be extracted to projects.

Install Package will move a package from wherever your downloaded it and move it to the game's resources.

Extract TTR will extract the game's files. See the "Creating a Project" section for more on this.

Managing Packages

The package panel will list all the packages you have installed with their name and size.

The checkbox to the right enables and disables the package. Generally, you should not need more than one package enabled at a time. But if your package is distributed in several pieces (like phase files) you will need to enable them all. If no packages are enabled, the game will run in its original state.

Pressing the X button will delete a package. This cannot be undone!

Warning: You must Enable/Disable packages before logging into Toontown Rewritten. It will not work while the game is running!

If you are only interested in playing other's content packs and not creating your own, the rest of the guide below does not apply to you.

Managing Projects

The project panel will list all of your projects with a button to view their files.

Pressing the X button will delete a project. This cannot be undone!

Creating a Project

Creating a good content pack is hard work, but with dedication you can create a work of art for many toons to enjoy.

To start a new project first click the button marked Extract TTR. This will extract Toontown Rewritten's game files to a new project. By default, only the files you can customize will be kept (textures and sounds); however, you can choose to extract all the other files, as well. Models can be viewed with the "pview" tool in Panda 3D.

Note: You can also extract content packages to create a new project. This is useful to see how one was made. However, it is generally frowned upon to steal other people's content for your own projects without permission first.

The game's content is split into "phases". Each phase contains folders such as "maps" and "bgm" and "sfx".

Customizing Textures

Textures in Toontown Rewritten are typically ".jpg" images found in the "maps" folder of a game's phase folder. While some are simple squares like floor tiles that repeat, many textures are grouped together as "palettes". The different parts of a palette are put onto models in the game.

Some textures are accompanied by a ".rgb" file. This contains a black and white silhouette of the texture representing what parts should be transparent. White is fully opaque, black is fully transparent, and shades of gray are a mixture of both.

While textures can be modified with any image tool, it works better to have one with advanced features like GIMP or Adobe Photoshop. ".rgb" files can't be created with MS Paint.

For a custom texture to work in the game it must follow strict rules. It must be the same file format (.jpg or .rgb), it must have the same pixel size, and it must have the same name as the original texture.

Note for advanced users: You actually can scale up the size of a texture to improve its quality but the length and width need to be the same ratio, and a power of 2. For example, to scale up a texture that is 64x128 pixels it can be turned into one that's 128x256 or 256x512. Do this sparingly. Larger textures use much more memory in game and may cause tremendous lag. And remember, if you scale up a texture, you must scale its ".rgb" file to the same size as well.

Customizing Sounds

Customizing sounds is a similar process to customizing textures. Music is found in a phase's "audio/bgm" folder. In Toontown Online they were midi sequences (.mid). If you want to create your own music that has the same kind of sound as the original, you should make a midi and convert it to ".ogg".

Remember that music in the game loops continuously. Make sure it sounds good looping before putting it in your project.

Sound effects are found in the "audio/sfx" folder and are also type ".ogg". (In the original game they were uncompressed ".wav" files.)

Like textures, sounds and music must have the same name and file type as the file they are replacing.

Compiling Your Project

Are you sure you're finished customizing the game? Delete any project files you haven't modified, including models and text files. This will reduce the size of the package and make it easier to find and avoid errors.

To make your project into a package simply press "Compile" and let the program do the rest.

If you log into Toontown Rewritten and your modified images/sounds appear then it was a success! If not, then you might have made a mistake. Make sure you followed the customizing rules exactly!