Skip to content

Commit 21299e9

Browse files
robotgryphonrobotgryphon
committed
Update license and readme
[no ci]
1 parent 1ac3630 commit 21299e9

File tree

2 files changed

+35
-24
lines changed

2 files changed

+35
-24
lines changed

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 Compact Mods
3+
Copyright (c) 2024 Compact Mods
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,61 @@
11
<a href="https://discord.gg/Y5QhUWxQdq" rel="nofollow"><img src="https://img.shields.io/discord/765363477186740234?label=Discord&amp;logo=discord&amp;logoColor=white&amp;style=for-the-badge" alt="Discord"></a>
22

3-
A Minecraft mod that adds one simple game mechanic: small rooms inside of blocks. You can grab the latest build off [Curseforge] or on [Github Releases].
3+
A Minecraft mod that adds one simple game mechanic: small rooms inside of blocks. You can grab the latest build off
4+
[Curseforge] or on [Github Releases].
45

56
| Version | Minecraft Version | Released | Support | Support Ends |
6-
| :-------------- | :---------------: | ------------: | :-----: | -------------- |
7-
| 5.2 | 1.19.2 | - | ✅ | - |
8-
| **5.1** | 1.19.2 | July 2022 | ✅ | - |
7+
|:----------------|:-----------------:|--------------:|:-------:|----------------|
8+
| **7.0** | 1.21.1 | 2024 | ✅ | - |
9+
| 6.0 | 1.20.1 | 2024 | ✅ | - |
10+
| 5.1 | 1.19.2 | July 2022 | ✅ | December 2024 |
911
| 5.0 | 1.19.2 | July 2022 | ❌ | July 2022 |
10-
| **4.5** | 1.18.2 | July 2022 | ❌ | September 2022 |
11-
| 4.4 | 1.18.2 | July 2022 | ❌ | - |
12-
| 4.3 | 1.18.2 | May 2022 | ❌ | - |
13-
| 4.2 | 1.18.2 | April 2022 | ❌ | - |
12+
| 4.5 | 1.18.2 | July 2022 | ❌ | September 2022 |
13+
| 4.4 | 1.18.2 | July 2022 | ❌ | July 2022 |
14+
| 4.3 | 1.18.2 | May 2022 | ❌ | July 2022 |
15+
| 4.2 | 1.18.2 | April 2022 | ❌ | May 2022 |
1416
| **4.0-beta2** | 1.16.5 | March 2021 | ❌ | July 2022 |
1517
| **3.0.19-b278** | 1.12.2 | May 2019 | ❌ | 2021 |
1618
| **2.0.1-b141** | 1.10.2 | October 2017 | ❌ | 2019 |
1719
| **1.21** | 1.7.10 | November 2015 | ❌ | 2017 |
1820

1921
\* *Note - only the most recent versions are shown here for brevity.*
2022

21-
Standard support policy is after a new version is released for the current Minecraft version, support for the previous version is dropped. If a new major Minecraft version is released and CM is updated, support for the previous major version is currently ***45*** days.
23+
Standard support policy is after a new version is released for the current Minecraft version, support for the previous
24+
version is dropped. If a new major Minecraft version is released and CM is updated, support for the previous major
25+
version is currently ***45*** days.
2226

2327
​
2428

2529
# Contributing
2630

2731
## Prerequisite: Github Packages
28-
First of all, thank you for wanting to help! To get started, you will need to set up authentication for Github Packages. Github has a guide for how to set up authentication here:
32+
First of all, thank you for wanting to help! To get started, you will need to set up authentication for Github Packages.
33+
Github has a guide for [how to set up authentication](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#authenticating-to-github-packages).
2934

30-
https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#authenticating-to-github-packages
35+
It is recommended to create a `gradle.properties` file in your user-level gradle folder to simplify working across
36+
multiple repositories.
3137

32-
It is recommended to create a `gradle.properties` file in your user-level gradle folder to simplify working across multiple repositories.
38+
## Project Layout
39+
Compact Machines is split into multiple projects to make updating and version maintenance easier.
40+
The following is a quick summary of each module's purpose:
3341

34-
## Modules
35-
Compact Machines is split into multiple modules to make updating and version maintenance easier. The following is a quick summary of each module's purpose:
42+
| Module | Description |
43+
|-----------------:|---------------------------------------------------------------------------|
44+
| core-api | Contains classes intended to be used by others mods to add functionality. |
45+
| neoforge-datagen | Contains data generators for worldgen/recipes/templates/etc. |
46+
| neoforge-main | Contains the main mod code loaded by the NeoForge mod loader. |
3647

37-
| Module | Description
38-
| --- | ---
39-
| core-api | Contains classes used across all other modules; modloader-independent.
40-
| core | Contains data classes and core functionality not tied to a mod loader.
41-
| tunnels-api | Shipped to end users as a baseline for working with tunnel integration.
42-
| forge-tunnels-api | Contains Forge-specific API code for tunnels. (Mainly capability support)
43-
44-
If you are interested in working with `core-api`, `core`, or `tunnels-api`, you can find them in the [core repository](https://github.com/CompactMods/compactmachines-core).
48+
## External Libraries
4549

50+
| Library | Description |
51+
|----------:|------------------------------------------|
52+
| [spatial] | A block-based spatial and maths library. |
53+
| [feather] | A node system built for Java. |
4654

4755
---
4856

4957
[Curseforge]: https://www.curseforge.com/minecraft/mc-mods/compact-machines
50-
[Github Releases]: https://github.com/CompactMods/CompactMachines/releases
58+
[Github Releases]: https://github.com/CompactMods/CompactMachines/releases
59+
60+
[spatial]: https://github.com/CompactMods/spatial
61+
[feather]: https://github.com/CompactMods/feather

0 commit comments

Comments
 (0)