Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/overfl0/armaclass
Python parser for Arma class definitions (e.g. sqm files)
https://github.com/overfl0/armaclass
arma3 class generator parser python python3 sqm
Last synced: 2 months ago
JSON representation
Python parser for Arma class definitions (e.g. sqm files)
- Host: GitHub
- URL: https://github.com/overfl0/armaclass
- Owner: overfl0
- License: mit
- Created: 2018-02-13T19:47:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T21:30:04.000Z (8 months ago)
- Last Synced: 2024-08-09T14:59:07.981Z (5 months ago)
- Topics: arma3, class, generator, parser, python, python3, sqm
- Language: Python
- Size: 4.38 MB
- Stars: 20
- Watchers: 4
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Status
[](https://github.com/overfl0/Armaclass/actions/workflows/build.yml)
[Live demo in your browser](https://overfl0.github.io/Armaclass/)
## About
This is a Python parser for Arma 3 class definitions such as those appearing inside unrapified mission files.
It's based on [Fusselwurm's arma-class-parser](https://github.com/Fusselwurm/arma-class-parser) that is written
JavaScript.
I grew tired of using it in conjunction with PyExecJS (complicated to set up and needing to patch things up on
Windows) and py2js (too slow to parse even 300KB sqm files) and decided to port the original JavaScript code to
Python.
[See how it works, directly in your browser!](https://overfl0.github.io/Armaclass/)
## Installation
```
pip install armaclass
```
## Usage
#### Parse the values from a string
```python
In [1]: import armaclass
In [2]: armaclass.parse('version=12;\n\nclass Moo {\r\n value = 1; };')
Out[2]: {'version': 12, 'Moo': {'value': 1}}
```
Note that due to Python's implementation of dicts, the keys order is kept the same
as in the class parsed.
#### Generate the files based on a parsed (or manually created) structure
```python
In [5]: structure = {'version': 12.0, 'Moo': {'value': 1.0}}
In [6]: print(armaclass.generate(structure))
version=12;
class Moo
{
value=1;
};
```
#### Indent with tabs instead of spaces
```python
In [7]: print(armaclass.generate(structure, indent=1, use_tabs=True))
version=12;
class Moo
{
value=1;
};
```
## Extending the generator
You can use this library to write a program that will port your Arma class files to DayZ, for example.
To do so, you will need to create your own generator by subclassing `armaclass.generator.Generator` and implementing
your own methods (the ones raising `NotImplemented`).
## Development
### Notes
The naming conventions may not match Python's pep8 as I was trying to stay close to the original parsing names to
facilitate porting. Those (internal) names may be changed in the future.
### Making code changes
- Create a virtualenv using your preferred method (mkvirtualenv, venv, etc...)
- `pip install -r requirements-dev.txt`
- Write code AND tests
- `pytest` to test run your tests
- `ptw -n` if you want `pytest` to automatically be called whenever
you save any file from the project
### Testing the cythonized wheels in cibuildwheel
cmd /C "set CIBW_BEFORE_BUILD=pip install -r requirements-cython.txt && set CIBW_SKIP=pp* && set CIBW_TEST_REQUIRES=pytest && set CIBW_TEST_COMMAND=pytest {project} && cibuildwheel --platform windows"
# On linux:
CIBW_BEFORE_BUILD='pip install -r requirements-cython.txt' CIBW_SKIP='pp*' CIBW_TEST_REQUIRES=pytest CIBW_TEST_COMMAND='pytest {project}' cibuildwheel --platform linux
## Contributing
If you feel something is missing or plain wrong, feel free to submit a Pull Request. You are encouraged to submit the
same PR/suggestion to the original [arma-class-parser](https://github.com/Fusselwurm/arma-class-parser) as well.