Tome
A generic data editor for games supporting arbitrary input and output formats.
|
Tome is a generic data editor for games supporting arbitrary input and output formats.
Developing games is all about data. With game systems for modifying data and user interfaces for presenting it, finding a sophisticated data model is key to creating successful games. Even more, being able to change this data and iterate on a day-to-day basis is mandatory in today's production cycles.
Tome solves two problems that arise with every new game you build: First, you can import the definition of your game's data so game designers can create new data records and modify existing ones very conveniently. Second, you can export the results to any format your game engine understands.
The tool is pretty self-explanatory. However, to give you a headstart, feel free to take a look at the Tome wiki pages.
Feel free to take a look at the public development roadmap.
We know that using a tool like Tome in production requires you to be completely sure about stability and compatibility. Thus, new releases of Tome are created using Semantic Versioning. In short:
We are sorry that you've experienced issues or are missing a feature! After verifying that you are using the latest version of Tome and having checked whether a similar issue has already been reported, feel free to open a new issue. In order to help us resolving your problem as fast as possible, please include the following details in your report:
After being able to reproduce the issue, we'll look into fixing it immediately.
You'd like to help make Tome even more awesome? Seems like today's our lucky day! In order to maintain stability of the tool and its code base, please adhere to the following steps, and we'll be pleased to include your additions in our next release.
Note that Tome is distributed under the GNU Lesser General Public License 3.0. So will be your code.
If you've got no idea how to help, head over to our issue tracker and see what you'd like to do most. You can basically pick anything you want to, as long as it's not already assigned to anyone.
If you know exactly what you're missing, open a new issue to begin a short discussion about your idea and how it fits the project. If we all agree, you're good to go!
Tome is developed using the GitFlow branching model. In order to contribute, you should check out the latest develop branch, and create a new feature or hotfix branch to be merged back.
Tome is based on Qt 5.8.
You might also want to take a look at the Tome API documentation (see below).
Finally, open a pull request so we can review your changes together, and finally integrate it into the next release.
Tome is built and deployed using the usual Qt tools for Windows and Mac OS X.
C:\Program Files (x86)\Qt\5.8\mingw53_32\bin\qtenv2.bat
to set up your environment variables.Bin\release\Tome
.windeployqt.exe Tome.exe
.C:\Program Files (x86)\Qt\Tools\mingw530_32\opt\bin\libeay32.dll
to the output directory (required for Google Sheets import).C:\Program Files (x86)\Qt\Tools\mingw530_32\opt\bin\ssleay32.dll
to the output directory (required for Google Sheets import).C:\Program Files (x86)\Qt\5.8\mingw53_32\bin\qtenv2.bat
to set up your environment variables.Bin\release\TomeIssueReporter
.windeployqt.exe TomeIssueReporter.exe
.C:\Program Files (x86)\Qt\Tools\mingw530_32\opt\bin\libeay32.dll
to the output directory (required for creating GitHub issues).C:\Program Files (x86)\Qt\Tools\mingw530_32\opt\bin\ssleay32.dll
to the output directory (required for creating GitHub issues).build-Tome-Desktop_Qt_5_8_0_clang_64bit-Release
.Qt/5.8/clang_64/bin/macdeployqt Tome.app -dmg
.We are using Doxygen for documenting the API of Tome. You can generate the files and add them to QtCreator as follows:
"C:\Program Files\doxygen\bin\doxygen.exe" Doxyfile
."C:\Program Files (x86)\Qt\5.8\mingw53_32\bin\qhelpgenerator.exe" Doc\Api\html\index.qhp
.Doc\Api\html\index.qch
to Tools > Options > Help > Documentation.You should now be able to access the full API documentation
Doc\Api\html\index.html
.The most recent API documentation is also available at http://www.tome-editor.org/api/1.0/.
Tome is released under the GNU Lesser General Public License 3.0.