Skip to content

Commit

Permalink
Merge pull request #35 from MeepishRealms/dev
Browse files Browse the repository at this point in the history
Merge v1.5.0 from Dev into Main
  • Loading branch information
bruglet authored Jun 11, 2024
2 parents 03cd877 + 5a1a64b commit e44d3b0
Show file tree
Hide file tree
Showing 47 changed files with 2,816 additions and 484 deletions.
20 changes: 10 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/.minecraft/saves/*
/.minecraft/logs/*
/.minecraft/dashloader-cache/*
/.minecraft/mods/*
/.minecraft/screenshots/*
/.minecraft/schematics/*
/.minecraft/crash-reports/*
saves/*
logs/*
screenshots/*
schematics/*
crash-reports/*
/.minecraft/.cache/*
/.minecraft/usercache.json
/.minecraft/usernamecache.json
*.mrpack
usercache.json
usernamecache.json
*.mrpack
/*.zip
/.idx/*
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
"editor.tabSize": 2,
"prettier.quoteProps": "consistent",
"editor.defaultFormatter": "esbenp.prettier-vscode",
"IDX.aI.enableInlineCompletion": true,
"IDX.aI.enableCodebaseIndexing": true,
}
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ A Minecraft modpack with deep potential for automation, building, collaboration,
Easy to grasp, difficult to master.
Modded Expansion is built around a vanilla aesthetic, extended midgame, automation, and building focus. Currently made for Forge 1.20.1.

[![Avaliable on Modrinth!](https://raw.githubusercontent.com/intergrav/devins-badges/2dc967fc44dc73850eee42c133a55c8ffc5e30cb/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/modpack/project-cog) [![Avaliable on Curseforge](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/available/curseforge_vector.svg)](https://www.curseforge.com/minecraft/modpacks/project-cog) [![Read the Documentation](https://raw.githubusercontent.com/intergrav/devins-badges/2dc967fc44dc73850eee42c133a55c8ffc5e30cb/assets/cozy/documentation/ghpages_vector.svg)](https://github.com/MeepishRealms/Cog/wiki)
[![Avaliable on Modrinth!](https://raw.githubusercontent.com/intergrav/devins-badges/2dc967fc44dc73850eee42c133a55c8ffc5e30cb/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/modpack/project-cog) [![Avaliable on CurseForge](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/available/curseforge_vector.svg)](https://www.curseforge.com/minecraft/modpacks/project-cog) [![Read the Documentation](https://raw.githubusercontent.com/intergrav/devins-badges/2dc967fc44dc73850eee42c133a55c8ffc5e30cb/assets/cozy/documentation/ghpages_vector.svg)](https://github.com/MeepishRealms/Cog/wiki)

## Installation and Server Hosting
To install Modded Expansion, you can use the following methods.

1. Install via Modrinth App [Recommended!]
2. Install via Prism Launcher using the Modrinth Tab
3. Install via Curseforge App [Not Recommended: This version has a few missing features!]
3. Install via Curseforge App

If you plan to host a server for Modded Expansion, either download the Server Instance ZIP or use a container template.

Expand All @@ -33,8 +33,9 @@ The following roadmap is subject to change at any time and future plans are not
- Build easier and fly using the jetpack!
- Simulate a real economy with a new monetary system!
- Unleash your building potential with Jetpacks, Litematica, Axiom, and the schematicannon!
- v1.5 - The Farsight Update
- v1.5 - The Farsight Update ✔️
- See Minecraft the way it was meant to be seen with expanded Shader support and compatibility with Distant Horizons-- see up to hundreds of chunks with shaders at over 120 FPS!
- All new foods and additions!
- v2.0 - The Tricky Trials Update
- Update to 1.21!
- Explore new Trail Chambers, Maces, and Wolf Armor.
Expand All @@ -51,13 +52,16 @@ Nearly all mods in this pack are uploaded on Modrinth. For a list of all mods th

The following mods/resouruce/data packs are bundled as an override, meaning that they are not distributed by Modrinth's servers, but rather included as a part of the `.mrpack` binary.

- **[Bobby Reforged](https://www.curseforge.com/minecraft/mc-mods/bobby-reforged)** by Anthxny
- The LGPL-3 used by the mod permits redistribution.
- *Source code avaliable at https://github.com/anthxnymc/BobbyReforged*
- **[Chimes](https://www.curseforge.com/minecraft/mc-mods/chimes)** by BlewberryPie
- Permission explicitly obtained from Mod Author. See [permission.png](https://github.com/MeepishRealms/Cog/tree/dev/overrides/legal/chimes/permission.png).
- Permission explicitly obtained from Mod Author. See [permission.png](chimes/permission.png).
- **[Cosmetic Armor Reworked](https://www.curseforge.com/minecraft/mc-mods/cosmetic-armor-reworked)** by LainMI
- The "Minecraft Mod Public License" used by the mod permits redistribution.
- *Source code avaliable at https://github.com/zlainsama/CosmeticArmorReworked*
- **[Create: Broken Bad](https://discord.gg/JzAQPX7kDR)** and **[Usable Product](https://discord.gg/JzAQPX7kDR)** by jetpacker06 and Yoyo
- Permission explicitly obtained from Mod Authors. See [permission1.png](https://github.com/MeepishRealms/Cog/tree/dev/overrides/legal/createbb/permission1.png), [permission2.png](https://github.com/MeepishRealms/Cog/tree/dev/overrides/legal/createbb/permission2.png), and [permission.png](https://github.com/MeepishRealms/Cog/tree/dev/overrides/legal/usableproduct/permission.png).
- **[Create: Broken Bad](https://www.curseforge.com/minecraft/mc-mods/create-broken-bad)** by jetpacker06
- Permission explicitly obtained from Mod Authors. See [permission1.png](createbb/permission1.png), [permission2.png](createbb/permission2.png), and [permission.png](usableproduct/permission.png).
- *Source code avaliable at https://github.com/jetpacker06/Create-Broken-Bad*
- **[Litematica](https://www.curseforge.com/minecraft/mc-mods/litematica)** by masady
- The LGPL-3 used by the mod permits redistribution.
Expand Down
14 changes: 14 additions & 0 deletions containers/compose/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Docker Compose
The recommended method to run Modded Expansion on Docker is using Docker Compose. Modern versions of Docker should come with compose functionality out-of-the-box.

**Note: Docker versions using a Windows kernel are not supported.**

## Installation

1. `cd` into the folder where you placed the `docker-compose.yml` file on your server.
2. Run the following command:
```
$ docker compose up -d
```

If your user is NOT part of the `docker` group, you will need to run the aforementioned command as root using `sudo` or other methods.
32 changes: 32 additions & 0 deletions containers/compose/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#To spin up this compose file, make sure you are "cd"'d into the directory where this file is stored.
#Then run `docker compose up -d"
services:
modded_expansion:
name: mrme
image: docker.io/itzg/minecraft-server:java17-graalvm
network: host
tty: true
stdin_open: true
volumes:
- mrme_world:/data
environment:
EULA: "true"
TYPE: "MODRINTH"
MODRINTH_MODPACK: "FpI88Ccr"
MODRINTH_DEFAULT_VERSION_TYPE: "release"
CONFIGPATH: "config"
MOTD: "MeepishRealms Modded Expansion Dedicated Server"
ICON: "https://www.dropbox.com/scl/fi/goueaqlx8sk3nctq44fe9/mrmediscord.png?rlkey=e00ucxfupu9rxbrivxiqpuoya&dl=1"
MEMORY: "8G"
JVM_OPTS: "-XX:+UseG1GC -XX:MaxGCPauseMillis=130 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:+AlwaysPreTouch -XX:G1NewSizePercent=28 -XX:G1HeapRegionSize=16M -XX:G1ReservePercent=20 -XX:G1MixedGCCountTarget=3 -XX:InitiatingHeapOccupancyPercent=10 -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=0 -XX:SurvivorRatio=32 -XX:MaxTenuringThreshold=1 -XX:G1SATBBufferEnqueueingThresholdPercent=30 -XX:G1ConcMarkStepDurationMillis=5 -XX:G1ConcRSHotCardLimit=16 -XX:G1ConcRefinementServiceIntervalMillis=150 -XX:AllocatePrefetchStyle=3 -XX:+UseTransparentHugePages -XX:+UnlockExperimentalVMOptions -XX:+UnlockDiagnosticVMOptions -XX:+AlwaysActAsServerClassMachine -XX:+AlwaysPreTouch -XX:+DisableExplicitGC -XX:+UseNUMA -XX:NmethodSweepActivity=1 -XX:ReservedCodeCacheSize=400M -XX:NonNMethodCodeHeapSize=12M -XX:ProfiledCodeHeapSize=194M -XX:NonProfiledCodeHeapSize=194M -XX:-DontCompileHugeMethods -XX:+PerfDisableSharedMem -XX:+UseFastUnorderedTimeStamps -XX:+UseCriticalJavaThreadPriority -XX:+EagerJVMCI -Dgraal.TuneInlinerExploration=1 -Dgraal.CompilerConfiguration=enterprise -XX:ConcGCThreads=4"
NETWORK_COMPRESSION_THRESHOLD: "256"
SYNC_CHUNK_WRITES: "false"
DIFFICULTY: "hard"
VIEW_DISTANCE: "16"
ALLOW_FLIGHT: "true"
SPAWN_PROTECTION: "0"
ENABLE_COMMAND_BLOCK: "true"
ENABLE_WHITELIST: "true"
ENFORCE_WHITELIST: "true"
SNOOPER_ENABLED: "false"
restart: always
43 changes: 43 additions & 0 deletions containers/quadlet/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Quadlet for Podman
The recommended method to run Modded Expansion on Podman is using Quadlets. Modern versions of Podman should come with quadlet functionality out-of-the-box.

*You can also use `podman-compose` along with the `docker-compose.yml` file in the containers folder as well, but this functionality will need to be installed separately.*

To begin, download the `mrme.container` and `mrme.volume` files within this folder onto your Linux server.

Next, decide if you want to run Modded Expansion as a rootful or rootless container.

## Rootless Installation (Recommended)
1. `cd` into the folder where you placed the Quadlet files on your server.
2. Move both `mrme.container` and `mrme.volume` into `~/.config/containers/systemd/`.
```
$ mv mrme.container mrme.volume ~/.config/containers/systemd/
```
3. Reload the systemd user daemon.
```
$ systemctl --user daemon-reload
```
4. Start the MR:ME service.
```
$ systemctl --user start mrme.service
```

The container will now automatically start and self-update on future boots.

## Rootful Installation
All commands for this set of instructions past the first step are required to be run as root, using `sudo` or otherwise.
1. `cd` into the folder where you placed the Quadlet files on your server.
2. Move both `mrme.container` and `mrme.volume` into `/etc/containers/systemd/`.
```
# mv mrme.container mrme.volume /etc/containers/systemd/
```
3. Reload the systemd system daemon.
```
# systemctl daemon-reload
```
4. Start the MR:ME service.
```
# systemctl start mrme.service
```

The container will now automatically start and self-update on future boots.
41 changes: 41 additions & 0 deletions containers/quadlet/mrme.container
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[Container]
#By using this Quadlet template, you are agreeing to Mojang's EULA.
Environment=EULA=true
#Container Properties
AutoUpdate=registry
ContainerName=mrme
Image=docker.io/itzg/minecraft-server:java17-graalvm
Network=host
PodmanArgs=--interactive --tty
Volume=mrme.volume:/data
#Modrinth Settings
Environment=TYPE=MODRINTH
Environment=MODRINTH_MODPACK=FpI88Ccr
Environment=MODRINTH_DEFAULT_VERSION_TYPE=release
Environment=CONFIGPATH=config
#Server Identity
Environment=MOTD="MeepishRealms: Modded Expansion Dedicated Server"
Environment=ICON=https://www.dropbox.com/scl/fi/goueaqlx8sk3nctq44fe9/mrmediscord.png?rlkey=e00ucxfupu9rxbrivxiqpuoya&dl=1
#Performance and Java Settings
Environment=MEMORY=8G
Environment=JVM_OPTS="-XX:+UseG1GC -XX:MaxGCPauseMillis=130 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:+AlwaysPreTouch -XX:G1NewSizePercent=28 -XX:G1HeapRegionSize=16M -XX:G1ReservePercent=20 -XX:G1MixedGCCountTarget=3 -XX:InitiatingHeapOccupancyPercent=10 -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=0 -XX:SurvivorRatio=32 -XX:MaxTenuringThreshold=1 -XX:G1SATBBufferEnqueueingThresholdPercent=30 -XX:G1ConcMarkStepDurationMillis=5 -XX:G1ConcRSHotCardLimit=16 -XX:G1ConcRefinementServiceIntervalMillis=150 -XX:AllocatePrefetchStyle=3 -XX:+UseTransparentHugePages -XX:+UnlockExperimentalVMOptions -XX:+UnlockDiagnosticVMOptions -XX:+AlwaysActAsServerClassMachine -XX:+AlwaysPreTouch -XX:+DisableExplicitGC -XX:+UseNUMA -XX:NmethodSweepActivity=1 -XX:ReservedCodeCacheSize=400M -XX:NonNMethodCodeHeapSize=12M -XX:ProfiledCodeHeapSize=194M -XX:NonProfiledCodeHeapSize=194M -XX:-DontCompileHugeMethods -XX:+PerfDisableSharedMem -XX:+UseFastUnorderedTimeStamps -XX:+UseCriticalJavaThreadPriority -XX:+EagerJVMCI -Dgraal.TuneInlinerExploration=1 -Dgraal.CompilerConfiguration=enterprise -XX:ConcGCThreads=4"
Environment=NETWORK_COMPRESSION_THRESHOLD=256
Environment=SYNC_CHUNK_WRITES=false
#Server Properties
Environment=DIFFICULTY=hard
Environment=VIEW_DISTANCE=16
Environment=ALLOW_FLIGHT=true
Environment=SPAWN_PROTECTION=1
Environment=ENABLE_COMMAND_BLOCK=true
Environment=ENABLE_WHITELIST=true
Environment=ENFORCE_WHITELIST=true
Environment=SNOOPER_ENABLED=false

[Service]
#Restarts container on crash unless manually stopped with systemctl.
Restart=always
TimeoutStopSec=120

[Install]
#Starts container on boot.
WantedBy=multi-user.target default.target
2 changes: 2 additions & 0 deletions containers/quadlet/mrme.volume
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[Volume]
VolumeName=mrme_world
Loading

0 comments on commit e44d3b0

Please sign in to comment.