Skip to content

Commit df5e3d1

Browse files
committed
Add license and readme
1 parent 948cfab commit df5e3d1

2 files changed

Lines changed: 64 additions & 0 deletions

File tree

LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright © 2026 Ruben Taelman
4+
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:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
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
21+
THE SOFTWARE.

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Cyclps Pack Tests
2+
3+
[![Build Status](https://github.com/CyclopsMC/packtests/workflows/gametests/badge.svg)](https://github.com/CyclopsMC/CyclopsCore/actions?query=workflow%3Agametests)
4+
5+
Repo for testing all Cyclops mods in a production client and server environment.
6+
7+
8+
### Motivation
9+
10+
While mods are always tested in isolation within their own development environment,
11+
development environments can always differ a bit compared to production environments,
12+
especially when combined with other mods.
13+
14+
As such, this repo aims to test real-world environments to ensure everything works as intended.
15+
16+
### Modpacks
17+
18+
This defines several modpacks (see `modpacks/`) for different mod loaders at different minecraft versions.
19+
These packs are defined in their own `pom.xml` file, which defines their precise version.
20+
Not all packs may be defined for all loaders and minecraft versions.
21+
22+
- `cyclops-all`: All mods developed under the Cyclops organization.
23+
- `cyclops-all-deps`: All mods developed under the Cyclops organization, including their optional dependencies.
24+
- `cyclops-id`: All Integrated Dynamics-related mods developed under the Cyclops organization.
25+
26+
### Testing
27+
28+
All packs are started in both a client and server environment, using the [mc-runtime-test](https://github.com/headlesshq/mc-runtime-test) and [mc-server-test](https://github.com/headlesshq/mc-server-test) GitHub actions.
29+
Additionally, [game tests](https://minecraft.wiki/w/GameTest) are executed.
30+
31+
### Automatic dependency updates
32+
33+
Using [Renovate](https://www.mend.io/renovate/), versions of all mods are always automatically updated to their latest version.
34+
This allows us to detect breaking changes immediately.
35+
36+
### Modpack downloads
37+
38+
The mod jars of all modpacks are made available as downloads.
39+
To access these, you open [the latest workflow run](https://github.com/CyclopsMC/packtests/actions/workflows/gametests.yml?query=branch%3Amaster),
40+
and download the artifact you are interested in (e.g. `cyclops-all-1.21.1-neoforge-mods`).
41+
42+
### License
43+
All code is licenced under the [MIT License](https://github.com/CyclopsMC/packtests/blob/master/LICENSE.txt)

0 commit comments

Comments
 (0)