Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pmarincak/gms2-mofile
MoFile loader for GameMaker Studio
https://github.com/pmarincak/gms2-mofile
game-development gamemaker gamemaker-language gamemaker-studio-2 gml localization
Last synced: 8 days ago
JSON representation
MoFile loader for GameMaker Studio
- Host: GitHub
- URL: https://github.com/pmarincak/gms2-mofile
- Owner: pmarincak
- License: other
- Created: 2022-08-06T02:45:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T18:36:20.000Z (11 months ago)
- Last Synced: 2024-08-02T07:10:34.702Z (3 months ago)
- Topics: game-development, gamemaker, gamemaker-language, gamemaker-studio-2, gml, localization
- Language: C++
- Homepage:
- Size: 267 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-gamemaker - gms2-mofile - Mofile reader used for localization. (Localization / Recommendations)
README
# gms2-mofile
MoFile loader for Gamemaker Studio 2.3+
## Table of Contents
1. [Requirements](#requirements)
2. [Download](#download)
3. [Maintainers & Contribution](#maintainers--contribution)
4. [Samples](#samples)
5. [Setup](#setup)
6. [Configuration](#configuration)
7. [Pulling Translation Strings From Code](#pulling-translation-strings-from-code)
8. [API](#api)
## Requirements
|Release Version| Gamemaker Version |
|--|--|
| 1.0.x | v2.3.0.x+ |
| 1.1.x | v2022.09.x.y+ |
## Download
1. Download the [exported local package](https://github.com/pmarincak/gms2-mofile/blob/main/export/com.package.gmlmofile.yymps)
2. Select Tools > Import Local Package
3. Navigate to the saved package and select import
4. Import all resources
## Maintainers & Contribution
This package is maintained by [Paige Marincak](https://twitter.com/paigemarincak/). To contribute, please fork the repo and make pull requests.
## Samples
Samples can be viewed [here](https://github.com/pmarincak/gms2-mofile/tree/main/samples).
## Setup
### PoEdit Files
1. Create a folder in your datafiles called **TranslationFiles**.
2. Copy the [sample.po and sample.mo](https://github.com/pmarincak/gms2-mofile/tree/main/samples/BasicSample/BasicSample/datafiles/TranslationFiles) files from the sample to the new folder.
### GML
1. Add **MofileGameStart()** to the GameStart of an object that is created at the start of the game.
2. Add **MofileGameEnd()** to the GameEnd of an object that is destroyed at the end of the game.
3. Load your mofile at any point after MofileGameStart using **MofileLoadLanguageFile("sample.mo")**
## Configuration
### GML
|Variable Name| Default Value | Description |
|--|--|--|
| MOFILE_INCLUDED_FILES_SUBDIRECTORY | "TranslationFiles" | Path to datafiles subdirectory where the mofiles are stored at runtime.
| MOFILE_USE_WORKING_DIRECTORY| true | Whether to preface MOFILE_INCLUDED_FILES_SUBDIRECTORY with the [working_directory](https://manual.yoyogames.com/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm) or not.
### Translation Functions
If you would like to rename **_** or **_MofileMarkTranslation**:
1. Rename the functions as preferred in the code. Example: **TL** and **TL_Marker**.
2. Open your Po File. (i.e. sample.po) Recommend using [PoEdit](https://poedit.net/).
3. Translation > Properties > Sources keywords
4. Change "_" to "TL" and "_MofileMarkTranslation" to "TL_Marker"
5. Press Ok.
### PoEdit
If you would like to use [PoEdit](https://poedit.net/) to pull translation strings from your code, you will need to create a custom extractor as follows:
1. Open PoEdit.
2. File > Preferences > Extractors
3. Click the + at the bottom.
4. Create the Extractor with the following configuration and click OK:
|Name|Value|
|--|--|
| Language | GML
| Extensions | *.gml
| Extraction Command | xgettext --language=C --add-comments=TRANSLATORS: --force-po -o %o %C %K %F
| Keywords List | -k%k
| Input File List | %f
| Charset | --from-code=%c
## Pulling Translation Strings From Code
1. Open your Po File. (i.e. sample.po) Recommend using [PoEdit](https://poedit.net/).
2. Press **Update From Code**
3. New strings added and removed will be visible
4. Save to generate a new MoFile.
## API
### MofileGameStart
Sets up the linkage between GML and the MoFile DLL. Should be called once at GameStart.
### MofileGameEnd
Frees the MoFile DLL. Should be called once at GameEnd.
### _
Marks the provided value as a translatable string and returns the translation from the loaded MoFile. Feel free to rename this function to whatever shorthand makes the most sense. Be aware that you will need to update PoEdit grep configurations.
@param {String} value
### _MofileMarkTranslation
Marks the provided value as a translatable string and returns the original value. Feel free to rename this function to whatever shorthand makes the most sense. Be aware that you will need to update PoEdit grep configurations.
@param {String} value
### MofileLoadLanguageFile
Loads the localization file represented by the provided filename and returns whether it was successful or not.
@param {String} filename