Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
a0a7 authored Aug 28, 2023
1 parent 4807935 commit 1027cd6
Showing 1 changed file with 61 additions and 36 deletions.
97 changes: 61 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,68 @@
<p align="center"><img src="https://github.com/alexandsr/ExtendedSeatingMod/assets/61996958/d6a4a7fd-f0e3-4f2a-9d6c-5ee3be5bf7df" alt="ExtendedSeating Logo" width="140"></p>
<h1 align="center">Create: Extended Seating

Installation information
=======
<div align="center">
<!--<a href="https://legacy.curseforge.com/minecraft/mc-mods/bellsandwhistles"><img src="https://cf.way2muchnoise.eu/905040.svg" alt="curseforge"></a>
<a href="https://modrinth.com/mod/bellsandwhistles"><img src="https://img.shields.io/modrinth/dt/gJ5afkVv?logo=modrinth&label=&suffix=%20&style=flat&color=242629&labelColor=5ca424&logoColor=1c1c1c" alt="modrinth"></a><br>
<img src="https://wakatime.com/badge/user/d3e71387-5f47-4f39-81e8-9b14b9457c4b/project/af4286ec-a411-416b-bfdf-cffd14a99214.svg" alt="wakatime">-->
<img src="https://img.shields.io/github/license/alexandsr/ExtendedSeatingMod" alt="license">
</div></h1>
<div align="center">
<h3>Create: Extended Seating is an addon for Create that extends Create's seating options,<br>adding 16 colored 'Chair' Blocks, an alternative to Create's Seat Blocks.</h3><br>
</div>
<img src="">
<h3>Current list of features:</h3>
<ul>
<li>Colored Chairs
<ul>
<li>Come in all 16 Minecraft Dye Colors</li>
<li>Right-click with a wrench to cycle armrest state (None, Left Only, Right Only, or Both Armrests)</li>
<li>Can be crafted either from 1 Colored Wool and 2 Wooden Slabs OR from 1 Colored Seat and 1 Wooden Slab</li>
<li>Can be sat on, both as a part of contraptions and standalone.</li>
<li>Can pick up entities just like Seat blocks</li>
<li>Bouncy!</li>
</ul>
<img src="https://github.com/alexandsr/ExtendedSeatingMod/assets/61996958/5df96470-97e6-4d3e-bd5c-ea18b20f902d" width="150">
<img src="https://github.com/alexandsr/ExtendedSeatingMod/assets/61996958/14ce4207-df3e-4ad7-970f-4c9135a2ed08" width="150"><br><br>
</li>
<li>Kelp Chair
<ul>
<li>Cheaper & easier-to-farm alternative to colored chairs</li>
<li>Can be crafted either from 1 Dried Kelp and 2 Wooden Slabs OR from 1 Kelp Seat block and 1 Wooden Slab</li>
<li>Work exactly the same as colored chairs</li>
</ul><br>
⠀⠀⠀<img src="https://github.com/alexandsr/ExtendedSeatingMod/assets/61996958/53210a6f-6343-41b9-944b-f9addc3937ce" width="100"><br><br>
</li>
<li>Kelp Seat
<ul>
<li>Cheaper & easier-to-farm alternative to colored seats</li>
<li>Can be crafted from 1 Dried Kelp item and 1 Wooden Slab</li>
<li>Work exactly like Create's seat blocks</li>
<li>Can be crafted or made in a stonecutter</li>
</ul><br>
⠀⠀⠀⠀<img src="https://github.com/alexandsr/ExtendedSeatingMod/assets/61996958/7c00abef-12eb-4fe5-a304-03dc4f2629d9" width="90"><br><br>

This template repository can be directly cloned to get you started with a new
mod. Simply create a new repository cloned from this one, by following the
instructions at [github](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
</li>
<li>Seatwood Planks
<ul>
<li>Useful together with Copycat Steps & Copycat Panels as a decoration for Seats & Chairs</li>
<li>3 Seatwood Planks can be crafted from 2 Wooden Slabs and 2 Wooden Planks</li>
</ul><br>
⠀⠀⠀⠀<img src="https://github.com/alexandsr/ExtendedSeatingMod/assets/61996958/a32ccba2-8e76-4e02-80b2-32213e0adca2" height=100>⠀
<img src="https://github.com/alexandsr/ExtendedSeatingMod/assets/61996958/cb8bbd71-91e9-484a-9c68-c6a7190fb681" height=100><br>
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀<i>Seatwood Tray Tables</i>
</li>

Once you have your clone, you can initialize your copy.

Setup Process:
--------
</ul>

Step 1: Open your command-line and browse to the folder where you extracted cloned your copy of this repository to.

Step 2: You're left with a choice.
If you prefer to use Eclipse:
1. Run the following command: `gradlew genEclipseRuns` (`./gradlew genEclipseRuns` if you are on Mac/Linux)
2. Open Eclipse, Import > Existing Gradle Project > Select Folder
or run `gradlew eclipse` to generate the project.
---

If you prefer to use IntelliJ:
1. Open IDEA, and import project.
2. Select your build.gradle file and have it import.
3. Run the following command: `gradlew genIntellijRuns` (`./gradlew genIntellijRuns` if you are on Mac/Linux)
4. Refresh the Gradle Project in IDEA if required.

If at any point you are missing libraries in your IDE, or you've run into problems you can
run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything
{this does not affect your code} and then start the process again.

Mapping Names:
============
By default, the MDK is configured to use the official mapping names from Mojang for methods and fields
in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this
license, if you do not agree with it you can change your mapping names to other crowdsourced names in your
build.gradle. For the latest license text, refer to the mapping file itself, or the reference copy here:
https://github.com/NeoForged/NeoForm/blob/main/Mojang.md

Additional Resources:
==========
Community Documentation: https://docs.neoforged.net/
NeoForged Discord: https://discord.neoforged.net/
<div align="center">

<h3>Find Create: Extended Seating on <a href="https://modrinth.com/mod/extendedseating"><span style="margin-top:6px"><img src="https://raw.githubusercontent.com/alexandsr/BellsAndWhistlesMod/main/.assets/modrinth.webp" width="16"></span> Modrinth</a> or <a href="https://legacy.curseforge.com/minecraft/mc-mods/extendedseating"><span style="padding:5px"><img src="https://raw.githubusercontent.com/alexandsr/BellsAndWhistlesMod/9f44e0cb812b00da5d1c60eb691efb9f69761cb3/.assets/curseforge.svg" width="18"></span> CurseForge</a>
<br><br>

Report Issues <a href="https://github.com/alexandsr/BellsAndWhistlesMod/issues">here</a></h3>
</div>

0 comments on commit 1027cd6

Please sign in to comment.