{"id":29481501,"url":"https://github.com/omnimodloader/lumina","last_synced_at":"2025-07-15T00:08:17.566Z","repository":{"id":304296726,"uuid":"902220376","full_name":"OmniModLoader/lumina","owner":"OmniModLoader","description":"Mapping library for OmniMC","archived":false,"fork":false,"pushed_at":"2025-07-12T07:58:27.000Z","size":89,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-12T08:22:05.667Z","etag":null,"topics":["java","library","mappings","minecraft","omnimc"],"latest_commit_sha":null,"homepage":"https://omnimc.org","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OmniModLoader.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-12T06:29:17.000Z","updated_at":"2025-07-12T07:55:20.000Z","dependencies_parsed_at":"2025-07-12T08:22:09.051Z","dependency_job_id":"b21b8844-7572-49e2-b22b-1e077a3717e9","html_url":"https://github.com/OmniModLoader/lumina","commit_stats":null,"previous_names":["omnimodloader/lumina"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/OmniModLoader/lumina","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniModLoader%2Flumina","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniModLoader%2Flumina/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniModLoader%2Flumina/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniModLoader%2Flumina/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OmniModLoader","download_url":"https://codeload.github.com/OmniModLoader/lumina/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniModLoader%2Flumina/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265378477,"owners_count":23755740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","library","mappings","minecraft","omnimc"],"created_at":"2025-07-15T00:08:16.920Z","updated_at":"2025-07-15T00:08:17.558Z","avatar_url":"https://github.com/OmniModLoader.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lumina\n\nWelcome to Lumina, a Java-based framework designed to simplify how you handle mappings, serialization, and\ndeserialization.\nWhether you’re working with full mappings, compressed mappings, or something in between,\nLumina makes it easy, efficient, and reliable. It’s built with flexibility in mind, so you can integrate it into your\nprojects seamlessly.\n\n## **What does Lumina do?**\n\nThis project is the mapping handler for [OmniMC](https://omnimc.org). We use this to control the mappings.\n\n- **Extensible Design**:\n    - Works with custom serializers like `LineSerializer` and `CompressedLineSerializer` for greater flexibility.\n\n- **Robust Error Handling**:\n    - The `FailedState` system handles errors gracefully and gives you all the info you need to debug.\n\n- **Centralized Failure Consumers**:\n    - Simplifies error management with classes like `AcceptConsumer` for reusable and streamlined handling.\n\n## **Getting Started**\n\nHere’s how to get Lumina up and running:\n\n1. **Check your setup**: Make sure you’re using Java 21 or higher.\n2. **Add Lumina to your project**:\n    - Clone the repository:\n    ```shell\n       git clone https://github.com/\u003cyour-repo\u003e/lumina.git\n    ```\nOr, include it as a dependency in your build system:\n\n- **Maven**:\n```xml\n       \u003cdependency\u003e\n         \u003cgroupId\u003eorg.omnimc\u003c/groupId\u003e\n         \u003cartifactId\u003elumina\u003c/artifactId\u003e\n         \u003cversion\u003e1.0.0\u003c/version\u003e\n       \u003c/dependency\u003e\n```\n\n- **Gradle**\n```groovy\n       implementation 'org.omnimc:lumina:1.0.0'\n```\n\n## **How to Use**\n### **Deserializing Mappings**\nLumina gives you specialized tools for deserialization, so you can adapt it to whatever kind of mapping format you’re working with.\n\n#### Full Deserialization:\nFor handling complete mappings like classes, fields, and methods, use `FullDeserializer`:\n```java\nFullDeserializer deserializer = new FullDeserializer();\nMappings mappings = ...; // Your Mappings instance\nFile mappingsDir = new File(\"mappings/\");\n\nif (deserializer.deserializeToFile(mappings, mappingsDir)) {\n    System.out.println(\"Full mappings deserialized successfully!\");\n}\n```\n\n### **Understanding Mapping Types**\n`MappingType` indicates what kind of mapping you're working with. Each type is tied to a specific serializer:\n- `FULL`: For uncompressed mappings.\n- `COMPRESSED`: Uses the `CompressedLineSerializer` for compressed data.\n- `PARAMETERS`: Specifically for parameter mappings.\n- `UNKNOWN`: For scenarios where the mapping type isn’t defined.\n\n#### Example usage\n```java\nMappingType type = MappingType.FULL;\nLineSerializer serializer = type.getLineSerializer();\nSystem.out.println(\"Serializer for FULL: \"+serializer);\n```\n\n### **Error Handling That Works for You**\nIf something goes wrong, Lumina has you covered with `FailedState`. You can create meaningful error states and handle them however you see fit:\n\n```java\nFailedState error = FailedState.of(\"Failed to deserialize\", ParameterDeserializer.class);\nSystem.err.println(error);\n```\nAnd if you want to automate failure handling, you can set up custom consumers with `AcceptConsumer`:\n```java\nAcceptConsumer consumer = new AcceptConsumer();\nconsumer.setConsumer(failedState -\u003e {\n    System.err.println(\"Error occurred: \" + failedState);\n});\n```\n\n## **Contributing**\nWe love contributions! Here’s how you can help grow Lumina:\n1. Fork the repo.\n2. Create a new branch for your feature or fix.\n3. Submit a pull request with a clear explanation of your changes.\n\nEvery contribution is appreciated, no matter how big or small.\n## **License**\nThis project is licensed under the [MIT License](LICENSE). That means you can use, modify, and distribute it freely, as long as you give credit where it’s due.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomnimodloader%2Flumina","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomnimodloader%2Flumina","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomnimodloader%2Flumina/lists"}