Skip to content

Commit a7f3c8a

Browse files
builtbyjonasbuiltbyjonas
committed
initial commit
1 parent dfcdd50 commit a7f3c8a

18 files changed

Lines changed: 683 additions & 24 deletions

‎.github/workflows/build.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: actions/setup-java@v4
16+
with:
17+
distribution: 'temurin'
18+
java-version: '17'
19+
20+
- name: Build with Gradle
21+
run: ./gradlew build

‎.github/workflows/release.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Release
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
build-and-upload:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-java@v4
14+
with:
15+
distribution: 'temurin'
16+
java-version: '17'
17+
18+
- name: Build with Gradle
19+
run: ./gradlew build
20+
21+
- name: Find JAR file
22+
id: find_jar
23+
run: |
24+
JAR_PATH=$(ls ./build/libs/tinyremapper-cli-*.jar | head -n 1)
25+
echo "jar_path=$JAR_PATH" >> $GITHUB_OUTPUT
26+
27+
- name: Upload Release Asset
28+
uses: softprops/action-gh-release@v2
29+
with:
30+
files: ${{ steps.find_jar.outputs.jar_path }}
31+
name: tinyremapper-cli.jar
32+
env:
33+
GITHUB_TOKEN: ${{ secrets.PAT }}

‎.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Gradle
2+
.gradle/
3+
build/
4+
bin/
5+
6+
# Eclipse / IntelliJ / VSCode
7+
.idea/
8+
*.iml
9+
*.iws
10+
out/
11+
.vscode/
12+
13+
# OS-specific
14+
.DS_Store
15+
Thumbs.db
16+
17+
# Log files
18+
*.log
19+
20+
# Java
21+
*.class

‎CHANGELOG.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
date format: YYYY-MM-DD
9+
10+
## [1.0.0] - 2025-05-01
11+
12+
### Added
13+
- Initial release of tinyremapper-cli.
14+
- Supports remapping Minecraft JAR files using Tiny mappings.
15+
- Command-line arguments for input JAR, output JAR, mapping file, from-namespace and to-namespace.

‎CODE_OF_CONDUCT.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Code of Conduct
2+
3+
We are committed to fostering a welcoming and inclusive environment.
4+
5+
## Our Pledge
6+
7+
We as contributors and maintainers pledge to make participation in our project
8+
a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity,
9+
gender identity and expression, level of experience, nationality, personal appearance, race,
10+
religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment:
15+
16+
- Using welcoming and inclusive language
17+
- Being respectful of differing viewpoints and experiences
18+
- Gracefully accepting constructive criticism
19+
20+
## Enforcement
21+
22+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported
23+
by contacting the maintainers at **me@binaryblazer.me**.
24+
25+
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org).

‎CONTRIBUTING.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to tinyremapper-cli
2+
3+
Thank you for considering contributing to tinyremapper-cli!
4+
We welcome all contributions — bug fixes, improvements, features, and documentation.
5+
6+
## How to contribute
7+
8+
1. Fork the repository
9+
2. Create a new branch (`git checkout -b feature/my-feature`)
10+
3. Commit your changes (`git commit -m 'Add my feature'`)
11+
4. Push to your branch (`git push origin feature/my-feature`)
12+
5. Open a Pull Request
13+
14+
## Guidelines
15+
16+
- Write clear, descriptive commit messages.
17+
- Keep Pull Requests focused and small.
18+
- Follow the existing code style.
19+
- Add tests when possible.
20+
- Update the `README.md` and `CHANGELOG.md` if necessary.
21+
22+
## Reporting issues
23+
24+
If you encounter bugs, security issues, or have feature requests,
25+
please open an [issue](https://github.com/threadmc/tinyremapper-cli/issues).
26+
27+
Thank you for your contribution! 🚀

‎LICENSE‎

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,21 @@
1-
BSD 3-Clause License
1+
MIT License
22

3-
Copyright (c) 2025, ThreadMC
3+
Copyright (c) 2025 ThreadMC
44

5-
Redistribution and use in source and binary forms, with or without
6-
modification, are permitted provided that the following conditions are met:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
711

8-
1. Redistributions of source code must retain the above copyright notice, this
9-
list of conditions and the following disclaimer.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1014

11-
2. Redistributions in binary form must reproduce the above copyright notice,
12-
this list of conditions and the following disclaimer in the documentation
13-
and/or other materials provided with the distribution.
14-
15-
3. Neither the name of the copyright holder nor the names of its
16-
contributors may be used to endorse or promote products derived from
17-
this software without specific prior written permission.
18-
19-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# tinyremapper-cli
2+
3+
A simple command-line tool to remap Minecraft jars using TinyRemapper.
4+
5+
## Features
6+
7+
- Remaps Minecraft jars using custom Tiny mappings
8+
- Lightweight CLI tool
9+
- Fast and easy to use
10+
11+
## Installation
12+
13+
Download the latest release jar from the [Releases](https://github.com/threadmc/tinyremapper-cli/releases) page.
14+
15+
## Usage
16+
17+
```bash
18+
java -jar tinyremapper-cli.jar --input server.jar --output remapped.jar --mappings mappings.tiny --from official --to named
19+
```

‎RELEASE_NOTES.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Release Notes
2+
3+
date format: YYYY-MM-DD
4+
5+
## v1.0.0 - 2025-05-01
6+
7+
### Highlights
8+
9+
- First stable release of tinyremapper-cli
10+
- Supports remapping Minecraft JAR files using Tiny mappings
11+
12+
### Features
13+
14+
- CLI interface with arguments for input, output, mappings, namespaces
15+
- Uses TinyRemapper library internally
16+
- Simple and fast remapping
17+
18+
### Notes
19+
20+
- Requires Java 17 or higher

‎SECURITY.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We will provide security updates for the latest stable release.
6+
7+
## Reporting a Vulnerability
8+
9+
If you discover a security vulnerability, please email **me@binaryblazer.me**.
10+
We will respond within 48 hours and work with you to resolve the issue promptly.
11+
12+
Please do not disclose security issues publicly before they are resolved.

0 commit comments

Comments
 (0)