Files
Content-Monorepo/README.md
omoso 169e25a649 update readme
Attempts to improve formatting a *little* bit. Also removed the Tutorial Worlds thing because it's planned to be separated into a public resource pack
2024-06-03 23:57:45 -05:00

96 lines
5.4 KiB
Markdown

# Re-Console
[<img alt="modrinth" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg">](https://modrinth.com/modpack/legacy-minecraft)
[<img alt="github" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/github_vector.svg">](https://github.com/Legacy-Union/Re-Console/releases) [<img alt="fabric" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg">](https://fabricmc.net/) [<img alt="adrenaline" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/adrenaline_vector.svg">](https://modrinth.com/modpack/adrenaline) [<img alt="kofi-singular" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/kofi-singular_vector.svg">](https://ko-fi.com/omoso)
![image](https://github.com/ViolaFlower/Re-Console/assets/144749186/0a962f41-5d52-401c-87c7-18e102d309df)
![Information](https://cdn.modrinth.com/data/cached_images/e25570e1d156c711baad158a5565061b157a94e9.webp)
Welcome back to your childhood.
Re-Console is the official modpack for the Legacy4J mod, seeking to be as accurate as to the idea of if Legacy Console Edition never ended as possible.
We do this via a variety of mods, resource packs and occasionally datapacks!
We seek to be as up-to date as possible update wise, mod wise and performance wise. The fastest time we updated in accordance with Legacy4J was a time of only **3 minutes!**
<p> We seek to be the gold standard of LCE modpacks, trying to push the ecosystem forward!
![Features](https://cdn.modrinth.com/data/cached_images/97029679acef552aaa93810310bee9e0f287dc5d.webp)
- Near 100% Legacy Console Edition parity
- Lightweight and performant; built on the [Adrenaline](https://modrinth.com/modpack/adrenaline) modpack, tweaked specifically for the most optimal, stable performance
- Entirely configurable and community oriented
- Optional old world generation, spanning from Beta 1.7.3 to 1.17.1
<p> Re-Console, and all the mods inside of it are either Open Source or Source Available!
**Want to keep up with Development? Join the [Legacy4J Discord Server](https://discord.com/invite/FJVbVgT9uS) for Sneak Peeks and updates on development!**
<details>
<summary>Important note for MacOS users</summary>
Re-Console needs the SDL2 framework to run, which is not installed on macOS by default. Here is a quick tutorial to do so:
1) Install the latest release here (for mac, it will be the .dmg installer): https://github.com/libsdl-org/SDL/releases
2) Run the installer
3) Open a new finder window, and in the upper left-hand portion of the screen, click `go`, `go to folder`, and enter this path: `/Library/Frameworks`
4) Drag the `SDL2.framework` folder from the installer to the framework directory
5) Launch ReConsole using the launcher of your choice. Click OK on the promts until your instance crashes
6) Open `System Settings`, go to `Privacy & Security`, and scroll down to where you see `"SDL2.framework" was blocked from use because it is not from an identified developer.`. Click `Allow Anyway`.
7) You can now launch ReConsole!
</details>
![Special Thanks](https://cdn.modrinth.com/data/cached_images/42bdd0b7ac744fbb277bcb8aea88598b682b9c07.webp)
- [bathtubfulloftoast](https://modrinth.com/user/bathtubfulloftoast) for making the [wiki](https://l4j.novassite.net/) for Re-Console
- [mzov_jen](https://modrinth.com/user/mzov_jen), for porting PACP to Modrinth + making a special compatible version for the modpack
- [S_N00B](https://modrinth.com/user/n00b) for making Console-Idated, of which this project was inspired from
![Not your cup of tea?](https://cdn.modrinth.com/data/cached_images/0c70e2e9dcbf8b50e1aa6f41388ef26875661063.webp)
Thats fine! Consider checking out;
- [Better Adventures++ LCE](https://modrinth.com/modpack/better-adventures++-lce) by FluffyPuppyKasey
- [Console-idated](https://modrinth.com/modpack/console-idated) by N00B (Has LEM compatibility)
- [Minecraft: Console Edition](https://modrinth.com/modpack/consoleedition) by omoso and ViolaFlower Modding
- [William's Console](https://modrinth.com/modpack/williams-console) by ContraryBaton60
# Need a server?
[![BisectHosting Partnership](https://cdn.modrinth.com/data/cached_images/3d811a958c28645cf1007ccc3d90cb282921bf7f.webp)](https://bisecthosting.com/raamviot50)
<details>
<summary>Credits</summary>
![Credits](https://cdn.modrinth.com/data/cached_images/60eabb80c3a86652dbc3b9323f70d5adc93a1d4a.webp)
# Developers
- omoso, Lead Developer
- Devin, Maintainer
- bathtubfulloftoast, Wiki Developer and Playtester
# Assistants and Contributors
- bathtubfulloftoast, Wiki Developer and Playtester
- Cjnator38, contributor
- dbtderpbox, Playtester
- Lenuilu, Playtester
- phofers, contributor
- TheMinecraftArchitect, contributor and Playtester
- WilyIcaro, Assistant
# Special Thanks
- dbtderpbox for fixing a crash with AMD GPUs on Linux
- Devin/Intergrav, creator of Adrenaline of which this modpack uses some of the config files, and offering to maintain the modpack
- Hypersoop, creator of Simply Optimized of which this modpack uses some of the config files
- S_N00B for making Console-idated, which inspired this project
- TheMinecraftArchitect for porting the Tutorial Worlds to Java Edition
</details>
**Re-Console is licensed Apache 2.0 from 0.1.0 to 0.3.3, and GPLv3 from 0.3.4 and onwards.**