zaaarf/lillero-mapper
1
0
Fork 0
mirror of https://github.com/zaaarf/lillero-mapper.git synced 2024-11-13 00:39:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

chore: basic readme

Browse source
This commit is contained in:
zaaarf 2023-08-26 22:12:26 +02:00
parent f4a6992f17
commit 12b48a4aa5
No known key found for this signature in database
GPG key ID: 6445A5CD15E5B40C
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md Normal file
View file

@ -0,0 +1,10 @@
# Lillero-mapper
A tiny library to process mappings in various formats.
## Why?
I initially [meant to fork Enigma](https://github.com/zaaarf/enigma), but honestly it was far more than I needed, even when stripped down to its core library.
The purpose of this library is to act as base for the [Lillero processor](https://github.com/zaaarf/lillero-processor/), to work with various mapping formats.
## Usage
Simply call `MapperProvider.getMapper()` and pass it a `List` of `String`s representing the mapping file's contents, line by line. Call then `populate()` on the resulting `IMapper`, passing the same `List` once again, and you'll have an object that can process stuff back and forth - granted that a mapper capable of parsing the input was found.