Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
52 changes: 0 additions & 52 deletions .github/workflows/ci.yml

This file was deleted.

Binary file modified .gitignore
Binary file not shown.
49 changes: 0 additions & 49 deletions .reuse/dep5

This file was deleted.

22 changes: 4 additions & 18 deletions ATTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,8 @@
# Attribution

## Author
Author: Reiasu

- **Reiasu** — original author and maintainer
Some of the particle math uses rhodonea curves and Lissajous figures.
Dragon respawn timing is based on vanilla's `DragonRespawnAnimation`.

## Algorithms & Inspirations

- **Rhodonea (rose) curves** — parametric polar curves `r = cos(kθ)` used in
center particle patterns (`ClientCenterEmitter`).
- **Lissajous figures** — `x = A sin(at + δ), y = B sin(bt)` used for
oscillating particle trails.
- **Ender Dragon respawn sequence** — timing constants derived from vanilla
Minecraft's `DragonRespawnAnimation` state machine (Mojang Studios).

## Third-Party Libraries

See `THIRD_PARTY_NOTICES.md` for full license texts of bundled/runtime dependencies.

## License

This project is licensed under LGPL-3.0-only. See `LICENSE` and `NOTICE` for details.
License: LGPL-3.0-only (see `LICENSE`)
35 changes: 6 additions & 29 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,33 +1,10 @@
Project: ReiParticleSkill Forge Workspace
SPDX-License-Identifier: LGPL-3.0-only

ReiParticleSkill
Copyright (C) 2025 Reiasu

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, version 3 of the License only (LGPL-3.0-only).
No "or later version" clause applies.

Note: This project is licensed solely under LGPL-3.0-only. The LGPL-3.0 text
incorporates GPLv3 conditions by reference, so the GPL-3.0 full text is
included in LICENSES/ for ease of review — not as a separate grant of rights.
See LICENSES/LGPL-3.0.txt and LICENSES/GPL-3.0.txt.

Modules:
1. ReiParticleSkill - Forge 1.20.1 particle effects mod
2. ReiParticlesAPI - Particle system API

License scope:
- All files in this project, including source code, build scripts, and
audio/visual assets, are licensed under LGPL-3.0-only.
Licensed under LGPL-3.0-only.
See LICENSE and LICENSES/ for full text.

Source code availability:
- If you redistribute the binary (jar), you must also make the corresponding
source code available (e.g., by providing the repository URL + version tag,
or otherwise as described in the LGPL-3.0).
- Source: https://github.com/reiasu2/ReiParticleSkill
For release builds, use the matching version tag (e.g., /tree/v1.0).
Source: https://github.com/reiasu2/ReiParticleSkill

Trademark notice:
- Minecraft is a trademark of Mojang Studios.
- This project is community-maintained and not endorsed by Mojang Studios.
Minecraft is a trademark of Mojang Studios.
This project is not affiliated with or endorsed by Mojang.
57 changes: 9 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,23 @@
# ReiParticleSkill Forge (1.20.1)
# ReiParticleSkill

[![License: LGPL-3.0-only](https://img.shields.io/badge/License-LGPL--3.0--only-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
Particle effects mod for NeoForge 1.21.1. Custom dragon respawn animations, skill VFX, etc.

A Minecraft Forge 1.20.1 particle effects mod featuring custom Ender Dragon respawn animations and visual effects.
## Structure

## Modules
- `forge-port/` — single module containing both ReiParticleSkill and ReiParticlesAPI

| Module | Description | Output Jar |
|--------|-------------|------------|
| `forge-port/` | ReiParticleSkill — main mod | `reiparticleskill-1.0-SNAPSHOT-forge-port.jar` |
| `forge-port-api/` | ReiParticlesAPI — runtime library | `reiparticlesapi-1.0-SNAPSHOT-forge-port.jar` |
One jar goes in `mods/`.

Both jars must be placed in the `mods/` folder.

## Requirements

- Minecraft 1.20.1
- Forge 47.2.0
- Java 17

## Building
## Build

```bash
# API module
cd forge-port-api
.\gradlew build

# Main mod
cd forge-port
.\gradlew build
```

Jars are output to `build/libs/` in each module.

## Development

```bash
cd forge-port
.\gradlew runClient
```
Requires Java 21 + NeoForge 21.1.173.

## License

This project is licensed under **LGPL-3.0-only**. See `LICENSE`, `ATTRIBUTION.md`, and the `LICENSES/` directory for details.

### For Modpack Authors / Players

- **Modpack distribution is allowed** — just keep the original `LICENSE` and `NOTICE` files
bundled with the mod jar intact. Do not prevent users from replacing or updating this mod.
- If you redistribute the jar, also provide a link to the corresponding source code
(repository URL + version tag or commit hash).
- You do **not** need to open-source your modpack or other mods just because you include this one.

### For Mod Developers

- You may depend on `ReiParticlesAPI` without your mod becoming LGPL, as long as users can
replace the API jar independently (which is the default in Forge's `mods/` folder).
- If you **modify and redistribute** this mod's source code, you must make your changes
available under LGPL-3.0 and clearly mark what you changed.

*The above is a simplified summary, not legal advice. See the full license texts for authoritative terms.*
LGPL-3.0-only. Modpack redistribution is fine, just keep the license files and link back to the source.
If you depend on the API, your mod doesn't need to be LGPL.
62 changes: 8 additions & 54 deletions THIRD_PARTY_NOTICES.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,19 @@
# Third-Party Notices

This file lists third-party libraries used by this project, along with their
respective licenses. These notices are provided in compliance with the license
terms of each dependency.

---

## ClassGraph

- **Artifact:** `io.github.classgraph:classgraph:4.8.174`
- **License:** MIT
- **Homepage:** https://github.com/classgraph/classgraph
- **Used by:** `forge-port-api` (runtime classpath scanning)

MIT License

Copyright (c) 2019 Luke Hutchison

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
`io.github.classgraph:classgraph:4.8.174` — MIT
https://github.com/classgraph/classgraph

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
Used for runtime classpath scanning in forge-port-api.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
## NeoForge

---
`net.neoforged:neoforge:21.1.173` — LGPL-2.1
https://neoforged.net

## Minecraft Forge

- **Artifact:** `net.minecraftforge:forge:1.20.1-47.2.0`
- **License:** LGPL-2.1-only (Forge), Minecraft EULA (Mojang)
- **Homepage:** https://minecraftforge.net
- **Note:** Forge is a modding platform; it is not bundled in the output jars.
Minecraft is proprietary software owned by Mojang Studios / Microsoft.
Forge's license has varied across versions; LGPL-2.1 is a simplified
description for the 1.20.x era. See Forge's own LICENSE for authoritative terms.

---
Not bundled in output jars.

## JUnit 5

- **Artifact:** `org.junit.jupiter:junit-jupiter` (test only)
- **License:** EPL-2.0
- **Homepage:** https://junit.org/junit5/
- **Note:** Test-scoped only; not included in release jars.

---

*This file is informational and does not constitute legal advice.*

*Maintainer note: If any third-party library is shaded/bundled into the
output jar in the future, its license and copyright notice must be added
to this file and included in the jar's `META-INF/` directory.*
`org.junit.jupiter:junit-jupiter` — EPL-2.0 (test only)
Loading