Differences

This shows you the differences between two versions of the page.

--- modding:omori_files_index [2021/09/19 12:12]
function created
+++ modding:omori_files_index [2021/09/19 14:25] (current)
function [steam_appid.txt]
@@ Line 1: / Line 1: @@
-This page lists the top-level directories and files in the OMORI game folder, which is usually //C:\Program Files (x86)\Steam\steamapps\common\OMORI// if you installed OMORI on your C: drive with Steam.
+This page lists the top-level directories and files in the OMORI game directory, which is usually //C:\Program Files (x86)\Steam\steamapps\common\OMORI// if you installed OMORI on your C: drive with Steam.
 Useful page when working with OMORI files: [[modding:file-types]]
@@ Line 5: / Line 5: @@
 Files or directories marked with a (T) are particularly interesting for translation projects.
-  * data/
+===== data/ =====
-    * This is a directory with encrypted files that's 100% identical with //www\/data\///. The reason for this clone is not known, but you can probably ignore it.
+This is a directory with encrypted files that's 100% identical with //[[#data1|www/data]]//. The reason for this clone is not known, but you can probably ignore it.
-  * locales/
-    * Seems to contain language data for the NW.js runtime. This is different from the language data or dialogue used by the game running inside NW.js, so you can definitely ignore these.
+===== locales/ =====
-  * pnacl/
+Seems to contain language data for the NW.js runtime. This is different from the language data or dialogue used by the game running inside NW.js, so you can definitely ignore these.
-    * //todo//
-  * swiftshader/
+===== pnacl/ =====
-    * //todo//
+//todo//
-  * tools/
-    * //todo//
+===== swiftshader/ =====
-  * www/
+//todo//
-    * Directory with mostly encrypted game assets.
-    * To inspect and modify these files, you need to [[modding:getting_started#decrypting_the_game|decrypt]] them, which will create a folder like //www_decrypt_abcd1234//, which has the same structure as //www\///, but with all files decrypted. We'll be referring to this folder as //www_decrypt\/// for simplicity.
+===== tools/ =====
-  * www_decrypt/
+//todo//
-    * This directory will be created when [[modding:getting_started#decrypting_the_game|decrypting]] the game files.
-    * [[modding:www-audio|audio/]]
+===== www/ =====
-      * Contains background music, sound effects, and more.
+Directory with mostly encrypted game assets.\\
-    * (T) [[modding:www-data|data/]]
+To inspect and modify these files, you need to [[modding:getting_started#decrypting_the_game|decrypt]] them, which will create a directory like //www_decrypt_abcd1234//, which has the same structure as //www//, but with all files decrypted. We'll be referring to this directory as //www_decrypt// for simplicity.\\
-      * Contains item, map, and event data like names, descriptions, values and more.
-    * (T) [[modding:www-fonts|fonts/]]
+===== www_decrypt/ =====
-      * Contains the fonts used by the game.
+This directory will be created when [[modding:getting_started#decrypting_the_game|decrypting]] the game files.
-      * If you're making a translation mod, you might need to modify the font files to support characters that might be missing from the original font, like ä, á, ß and more.
-    * icon/
+==== audio/ ====
-      * icon.png
+Contains background music, sound effects, and more.\\
-        * Not sure where this OMORI icon is used.
+Contents and details: [[modding:www-audio|www/audio]]
-        * //todo//
-    * (T) [[modding:www-img|img/]]
+==== data/ ====
-      * Contains all the sprites, backgrounds, and other graphics for the game.
+(T)\\
-    * js/
+Contains item, map, and event data like names, descriptions, values and more.\\
-      * Contains the game's code.
+Contents and details: [[modding:www-data|www/data]]
-      * libs/
-        * Contains library files that the game is using. You can probably ignore these.
+==== fonts/ ====
-      * (T) [[www-js-plugins|plugins/]]
+(T)\\
-        * Contains all the plugins in the game, which seems to be all the code that OMORI has that's not part of core RPG Maker MV. They are less "plugins" in a conventional sense, and more like normal JavaScript files that overwrite or extend existing classes and functions.
+Contains the fonts used by the game.\\
-        * For translation projects, these files contain certain UI and battle text.
+If you're making a translation mod, you might need to modify the font files to support characters that might be missing from the original font, like ä, á, ß and more.\\
-        * Info on how to work with .js files: [[modding:file-types#js_-_javascript]]
+Contents and details: [[modding:www-fonts|www/fonts]]
-      * main.js
-        * The entrypoint for the game. You can probably ignore it.
+==== icon/ ====
-      * plugins.js
+Contains a single //icon.png//. This file is used by //package.json// as data for NW.js. Maybe it's the icon in the window title bar in the top left.
-        * Plugin map generated through RPG Maker. Don't edit this file, OneLoader manages this when you develop mods.
-      * rpg_[...].js
+==== img/ ====
-        * RPG Maker runtime files. Don't touch these unless you know what you're doing.
+(T)\\
+Contains all the sprites, background, and other graphics for the game.\\
+Contents and details: [[modding:www-img|www/img]]
+==== js/ ====
+Contains the game's code.\\
+  * libs/
+    * Contains library files that the game is using. You can probably ignore these.
+  * plugins/
+    * (T)
+    * Contains all the plugins in the game, which seems to be all the code that OMORI has that's not part of core RPG Maker MV. They are less "plugins" in a conventional sense, and more like normal JavaScript files that overwrite or extend existing classes and functions.
+    * For translation projects, these files contain certain UI and battle text.
+    * [[modding:file-types#js_-_javascript|Info on how to work with .js files]]
+    * Contents and details: [[www-js-plugins|www/js/plugins]]
+  * main.js
+    * The entrypoint for the game. You can probably ignore it.
+  * plugins.js
+    * Plugin map generated through RPG Maker. Don't edit this file, OneLoader manages this when you develop mods.
+  * rpg_[...].js
+    * RPG Maker runtime files. Don't touch these unless you know what you're doing.
+==== languages/ ====
+(T)\\
+Contains the different languages the game natively supports. As of now (OMORI v1.0.8), there's only the normal English files, and a single file for an upcoming official Japanese translation (Omocat tweeted a long time ago about it).\\
+For translation projects, YAML files get patched on top of the //en// directory by OneLoader.\\
+Contents and details: [[modding:www-languages-en|www/languages/en]]
+==== maps/ ====
+Seems to contain the actual map data, unlike the triggers/actions/events that [[modding:www-data#mapxxxjson|www_decrypt/data/MapXXX.json]] files seems to contain.
+==== movies/ ====
+(T)\\
+Video files used by the game in cutscenes.\\
+Contents and details: [[modding:www-movies|www/movies]]
+==== save/ ====
+Save data. Also contains some OneLoader data.\\
+Contents and details: [[modding:www-save|www/save]]
+==== editor.json ====
+//todo//
+==== index.html ====
+Entrypoint for the game. OMORI uses RPG Maker MV, which in turn uses NW.js, which uses a web browser for the graphics. This HTML file loads all the assets, core libraries, plugins, and finally the start script for the game (main.js). This file, and by extension, the game, doesn't work in a normal browser like Google Chrome out of the box, because the game is using NW.js APIs that don't exist there. There have been successful attempts at running OMORI in a normal browser which we won't go into detail about here.
+==== package.json ====
+Contains some metadata about the game and configuration for NW.js, like the window title, icon, CLI arguments, and file to load (index.html).
+==== steam_appid.txt ====
+Contain's the game's ID on Steam. This can tell Steam which game you're playing (shown in friends list), and is also used for [[wp>Digital_rights_management|DRM]] checks in other games (not in OMORI).

mods.one modding wiki

User Tools

Site Tools

Differences

Page Tools