Distribution
This guide covers packaging and sharing language packs with the Arsenal community.
Packaging
Contents
Package your entire language folder. The structure below is an example, you can organize your files differently:
de-DE/
├── _manifest.json
├── flag.png
└── translations/
├── dialogs.json
├── menus.json
├── misc.json
├── notifications.json
├── onboarding.json
├── settings.json
├── tutorials.json
└── ui.jsonCreating a ZIP Archive
- Navigate to your
resources/locale/folder - Right-click your language folder (e.g.,
de-DE) - Compress into a
ZIPfile - Name format:
HD2Arsenal-[Language]-[code].zip
Examples:
HD2Arsenal-German-de-DE.zipHD2Arsenal-French-fr-FR-v1.0.zip
Installation Instructions
As a convention, you should include these instructions for users in a .txt file:
Arsenal Language Pack Installation
=====================================
1. Locate your Arsenal installation folder
2. Navigate to: resources/locale/
3. Extract the language folder (e.g., de-DE) into this location
4. Restart Arsenal
5. Go to Settings and select your languageManaging Updates
When Arsenal updates with new strings:
- Compare your files against updated English files
- Add translations for new keys
- Update any changed keys
- Increment your version number
Quality Assurance
Before Distribution
Verify:
- All files present and valid JSON
- Manifest correctly configured
- Flag image displays properly
- All strings translated
- Placeholders preserved correctly
- Tested in Arsenal
Testing Areas
- Navigation menu
- Settings page
- All dialogs
- Notifications/toasts
- Tooltips
- Context menus
- Error messages
- Mod Builder interface
Official Inclusion
High-quality language packs may be considered for official inclusion in Arsenal.
Requirements
- Complete translation coverage
- Accurate and natural translations
- Tested thoroughly
- Maintained actively
How to Submit
- Contact the Arsenal development team by joining the Official Discord
- Provide your language pack for review
- Respond to feedback and make improvements
- If accepted, your pack joins official releases