Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove fabric-api dependence for Fabric #289

Merged
merged 21 commits into from
Jun 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
db34f7e
docs: remove fabric api and archi api installation description
boholder Jun 9, 2024
bf22ed7
docs: fix set up guide link from windows link to general guide link
boholder Jun 9, 2024
ffb45b3
docs: add home page link to guide pages
boholder Jun 9, 2024
58e0b49
docs: extract good resource part as independent guide page, add links…
boholder Jun 9, 2024
b444208
docs: remove some resource links from README
boholder Jun 9, 2024
7764e45
docs: no need to manually install tolk in set up guide
boholder Jun 9, 2024
1b95b28
docs: rearrange mod installation part in setup guide
boholder Jun 9, 2024
73d3c74
docs: rewrite resource page
boholder Jun 9, 2024
a90cd1c
fix: fix forge crush after upgrading to 1.20.6
boholder Jun 9, 2024
4f99de4
fix: upgrade java version to 21 in common mixin config
boholder Jun 9, 2024
6d277d9
revert: docs: remove fabric api and archi api installation description
boholder Jun 9, 2024
d9b40e8
build: remove unused archi api version gradle config
boholder Jun 9, 2024
5d02bd2
feat: remove fabric api dependence on keybinding registering
boholder May 17, 2024
063c0b1
feat: remove fabric api dependence on client tick event triggering
boholder Jun 9, 2024
b870fd9
build: remove fabric api from gradle config
boholder Jun 9, 2024
029f06b
fix: fabric game start crush
boholder Jun 9, 2024
7d9738f
fix: fabric can't load lang file
boholder Jun 9, 2024
292277a
docs: remove fabric api installation description
boholder Jun 9, 2024
c1c65c3
fix: deprecated gradle config
boholder Jun 9, 2024
2e20554
build: remove fabric api related from release workflow
boholder Jun 9, 2024
a3397d2
build: 1.6.1
boholder Jun 9, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,6 @@ jobs:
echo "GIT_VERSION_TAG=${GIT_VERSION_TAG}" >> $GITHUB_ENV

echo "release-tag=${GIT_VERSION_TAG}" >> $GITHUB_OUTPUT

echo "FABRIC_API_VERSION=$(grep "fabric_api_version" gradle.properties | cut -d'=' -f2)" >> $GITHUB_ENV

# Create temp changelog files, add content from input and documentation files
#
Expand Down Expand Up @@ -155,8 +153,6 @@ jobs:
loaders: fabric
game-versions: ${{ env.MINECRAFT_VERSION }}
java: ${{ env.JAVA_VERSION }}
dependencies: |
fabric-api@${{ env.FABRIC_API_VERSION }}(required)
retry-attempts: 2
retry-delay: 60000

Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ Each version of mod will be pre-released on [GitHub](https://github.com/khanshoa
* [Configuration](/doc/CONFIG.md)
* [Sound Effects](https://html-preview.github.io/?url=https://github.com/khanshoaib3/minecraft-access/blob/1.20/doc/SOUND.html)
* [FAQ](/doc/FAQ.md)
* [Good Resources](/doc/GOOD_RESOURCES.md)

## Useful Links

* [Minecraft Wiki](https://minecraft.wiki) - Has details and guides on everything about Minecraft.
* [Minecraft Survival Guide (Season 3)](https://www.youtube.com/watch?v=VfpHTJsn9I4&list=PLgENJ0iY3XBjmydGuzYTtDwfxuR6lN8KC) - A great series by Pixlriffs, highly recommend for beginners.
* [Playability Discord server](https://discord.gg/yQjjsDqWQX) - Join our Discord server if you want to chat with other this mod's users and developers.
* [Twitter](https://twitter.com/shoaib_mk0) - You can follow the developer on Twitter to get notification when a new update drops.
* [Patreon](https://www.patreon.com/shoaibkhan)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"required": true,
"minVersion": "0.8",
"package": "com.github.khanshoaib3.minecraft_access.mixin",
"compatibilityLevel": "JAVA_17",
"compatibilityLevel": "JAVA_21",
"client": [
"AnimatedResultButtonAccessor",
"AnimatedResultButtonMixin",
Expand Down
10 changes: 9 additions & 1 deletion doc/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
Release v1.6.1 (2024-06)
---------------------------

### Others

- New guide page: [Good Resources](/doc/GOOD_RESOURCES.md)
- Remove `fabric-api` dependence for Fabric

Release v1.6.0 (2024-06)
---------------------------

Expand All @@ -21,7 +29,7 @@ Release v1.6.0 (2024-06)

### Others

- Remove `architectury-api` denpendence
- Remove `architectury-api` dependence

### Development Chores

Expand Down
4 changes: 3 additions & 1 deletion doc/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,9 @@ See also: [Feature Description](/doc/FEATURES.md#other-small-features)

## Other Pages

* [Home](/README.md)
* [Set Up](/doc/SET_UP.md)
* [Features](/doc/FEATURES.md)
* [Keybindings](/doc/KEYBINDINGS.md)
* [FAQ](/doc/FAQ.md)
* [FAQ](/doc/FAQ.md)
* [Good Resources](/doc/GOOD_RESOURCES.md)
11 changes: 10 additions & 1 deletion doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,13 @@ Please provide these information to developers in "mc-issues" channel:
* What feedback the game and mod gave you
* In case the developers asking for log files: there would be log files under the `logs` folder in your `.minecraft` folder, developers need the `debug.log` file, please upload it to wherever that developers can view.

It might be a bug of this mod, or something in mod manual is misleading, or you misunderstand how the game works like.
It might be a bug of this mod, or something in mod manual is misleading, or you misunderstand how the game works like.

## Other Pages

* [Home](/README.md)
* [Set Up](/doc/SET_UP.md)
* [Features](/doc/FEATURES.md)
* [Keybindings](/doc/KEYBINDINGS.md)
* [Configuration](/doc/CONFIG.md)
* [Good Resources](/doc/GOOD_RESOURCES.md)
4 changes: 3 additions & 1 deletion doc/FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,9 @@ Set the game to your familiar language is recommended, even if it's not supporte

## Other Pages

* [Home](/README.md)
* [Set Up](/doc/SET_UP.md)
* [Keybindings](/doc/KEYBINDINGS.md)
* [Configuration](/doc/CONFIG.md)
* [FAQ](/doc/FAQ.md)
* [FAQ](/doc/FAQ.md)
* [Good Resources](/doc/GOOD_RESOURCES.md)
63 changes: 63 additions & 0 deletions doc/GOOD_RESOURCES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Good Resources

1. [Helpful links](#helpful-links)
2. [Quality of Life Mods](#quality-of-life-mods)
3. [Tutorial Resources](#tutorial-resources)
4. [A Very Simple Beginner Guide](#a-very-simple-beginner-guide)

## Helpful Links

* [The manual of this mod](https://github.com/khanshoaib3/minecraft-access) - Check what features this mod provides.
* [Twitter](https://twitter.com/shoaib_mk0) - You can follow the developer on Twitter to get notification when a new update drops.
* [Playability Discord server](https://discord.gg/yQjjsDqWQX) - Again, you can join our Discord server if you need help in setting up the mod or any issue related to Minecraft Java.

## Quality of Life Mods

Here are some mods that can improve your game experience.
There are guides about [installing](/doc/SET_UP_ON_WINDOWS.md#install-mods) and [upgrading](/doc/SET_UP_ON_WINDOWS.md#upgrade-the-game-and-mods) mods.

1. Client side, which you can use in both single-player and multiplayer game:
* Presence Footsteps ([Fabric](https://modrinth.com/mod/presence-footsteps), [Forge port](https://www.curseforge.com/minecraft/mc-mods/presence-footsteps-forge)): Footstep sound enhancement mod. If the Fabric version of mod isn't work, select `Default sound pack` in the resource pack menu. If the mod has not supported your game version, you would consider to use this resource pack
instead: [Presence Footsteps: Remastered Sounds Pack](https://modrinth.com/resourcepack/presense-footsteps-sounds), put it under `%appdata%\.minecraft\resourcepacks` folder.
* Just Enough Items ([Fabric and Forge](https://modrinth.com/mod/jei)): Item and recipe viewing mod, far better than similar recipe book feature in original game (but this mod hasn't been 100% accessible by us, you need some vision to use it).
* Sound Physics Remastered ([Fabric and Forge](https://modrinth.com/mod/sound-physics-remastered)): Provides realistic sound attenuation, reverberation, and absorption through blocks. I'm sure this mod consumes resources, so install it only when you're confident in your PC hardware.

2. Server side, which you can only use in single-player game (unless the multiplayer server admins add them into the server):
* Tree Harvester ([Fabric and Forge](https://modrinth.com/mod/tree-harvester)): Harvest trees and huge mushrooms instantly with an axe. It's a common scenario in Minecraft that you can't reach the logs and leaves at higher place when standing on the ground, with this mod, you won't bother yourself with stepping yourself up.
* Carry On ([Fabric and Forge](https://modrinth.com/mod/carry-on)): Allowing players to pick up, carry, and place some blocks (such as Chests) and animals without breaking blocks or guiding animals with a leash.
* FTB Ultimine ([Fabric](https://www.curseforge.com/minecraft/mc-mods/ftb-ultimine-fabric), [Forge](https://www.curseforge.com/minecraft/mc-mods/ftb-ultimine-forge)): This mod can makes you operate on same type blocks around you by operating only once, like harvest crops, mining a vein and chopping trees.

## Tutorial Resources

Generally Minecraft gameplay tutorials:

* [Minecraft Wiki](https://minecraft.wiki/w/Minecraft_Wiki) - Has details and guides on everything about Minecraft, it also has [many detailed text tutorials](https://minecraft.wiki/w/Tutorials) on it.
* [Minecraft Survival Guide (Season 3)](https://www.youtube.com/watch?v=VfpHTJsn9I4&list=PLgENJ0iY3XBjmydGuzYTtDwfxuR6lN8KC) - by [Pixlriffs](https://www.youtube.com/@Pixlriffs) on YouTube in English

Gameplay showcase videos with this mod (many thanks for making them) (might outdated comparing to latest version of this mod):

* [Minecraft (java version)::Accessibility Showcase](https://www.youtube.com/watch?v=efE4KofiWXM) - by [TrueBlindGaming](https://www.youtube.com/@TrueBlindGaming) on YouTube in English
* [How to Install Mine Craft Access, a mine craft java mod for the blind](https://www.youtube.com/watch?v=MTRG3S0xeeg) - by [Logic Pro X Gaming](https://www.youtube.com/@LogicProXGaming) on YouTube in English
* [【我的世界·MC】视障辅助MOD安装与使用教程](https://www.bilibili.com/video/BV1W24y1T7f9) - by [红马尾战士紫月sama](https://space.bilibili.com/19268546) on Bilibili in Chinese
* [一个全盲视障者玩家的基建经验,来教盲人小伙伴们如何修房子](https://www.bilibili.com/video/BV1eh411N7y1) - by [红马尾战士紫月sama](https://space.bilibili.com/19268546) on Bilibili in Chinese

Search on [Google](https://www.google.com), Minecraft has a long history since 2009 and there are many tutorials about it, almost every question already had been answered.
Ask AI, no kidding, platforms like [Perplexity](https://www.perplexity.ai/) and [ChatGPT](https://chatgpt.com/) do know much about Minecraft since they are fed with amount of knowledge about it on Internet.

## A Very Simple Beginner Guide

Try reading [text tutorials for beginners on Minecraft Wiki](https://minecraft.wiki/w/Tutorials), if you find out that listening YouTube videos to learn to play this game is slow or difficult.
Because Minecraft's world generation is randomized, you may run into the difficulty of trying to generate multiple worlds but all of their spawn location are bad. You can search good [world generation seeds](https://minecraft.wiki/w/Seed_(level_generation)) [on Google](https://www.google.com/search?client=firefox-b-d&q=minecraft+good+seed) and set them when you're creating single player worlds.

I highly recommend you lower the difficulty of the game to get better experience, such as change the [difficulty](https://minecraft.wiki/w/Difficulty) to `Peaceful` to avoid monster spawning, or [use](https://www.minecraft.net/en-us/article/minecraft-commands) [commands](https://minecraft.wiki/w/Commands) to gain advantages (remember to turn on `Allow Cheats` option when you create the world).
Some commands are very convenient when you're playing single player worlds, such as ` /gamerule keepInventory true` to keep your inventory (highly recommended), `/tp` to teleport to another location, `/locate village` to find the nearest village, `/attribute @p minecraft:generic.max_health base set 1000` to make you take more damage so you can explore the game features freely, etc.

## Other Pages

* [Home](/README.md)
* [Set Up](/doc/SET_UP.md)
* [Features](/doc/FEATURES.md)
* [Keybindings](/doc/KEYBINDINGS.md)
* [Configuration](/doc/CONFIG.md)
* [Sound Effects](https://html-preview.github.io/?url=https://github.com/khanshoaib3/minecraft-access/blob/1.20/doc/SOUND.html)
* [FAQ](/doc/FAQ.md)
9 changes: 4 additions & 5 deletions doc/MOD_COMPATIBILITY.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
Compatibility For 1.20.6
---------------------------

* Minecraft: 1.20.6 ([read setup guide](/doc/SET_UP_ON_WINDOWS.md))
* Minecraft: 1.20.6 ([read setup guide](/doc/SET_UP.md))
* Java: >=21 ([download x64 Windows installer](https://download.oracle.com/java/21/latest/jdk-21_windows-x64_bin.msi), [download page for all Operating Systems](https://www.oracle.com/java/technologies/downloads/#java21))
* Fabric Loader: >=0.15.11 ([download Fabric Loader](https://fabricmc.net/use/installer/))
* Fabric API: 0.98.0+1.20.6 ([download Fabric API](https://cdn.modrinth.com/data/P7dR8mSH/versions/191HCCtF/fabric-api-0.98.0%2B1.20.6.jar))
* Forge: 1.20.6-50.0.* ([download Forge installer](https://maven.minecraftforge.net/net/minecraftforge/forge/1.20.6-50.0.31/forge-1.20.6-50.0.31-installer.jar))

Compatibility For 1.20.4
---------------------------

Haven't changed since [1.5.0+1.20.4](https://github.com/khanshoaib3/minecraft-access/releases/tag/v1.5.0-1.20) (released on 2024 Jan 16).

* Minecraft: 1.20.4 ([read setup guide](/doc/SET_UP_ON_WINDOWS.md))
* Minecraft: 1.20.4 ([read setup guide](/doc/SET_UP.md))
* Fabric Loader: >=0.15.1 ([download Fabric Loader](https://fabricmc.net/use/installer/))
* Fabric API: 0.93.1+1.20.4 ([download Fabric API](https://cdn.modrinth.com/data/P7dR8mSH/versions/2sYBLn0C/fabric-api-0.93.1%2B1.20.4.jar))
* Forge: 1.20.4-49.0.19 ([download Forge installer](https://maven.minecraftforge.net/net/minecraftforge/forge/1.20.4-49.0.19/forge-1.20.4-49.0.19-installer.jar))
Expand All @@ -23,7 +22,7 @@ Compatibility For 1.20.1

Haven't changed since [1.4.1+1.20.1](https://github.com/khanshoaib3/minecraft-access/releases/tag/v1.4.1-1.20.1) (released on 2023 Dec 13).

* Minecraft: 1.20.1 ([read setup guide](/doc/SET_UP_ON_WINDOWS.md))
* Minecraft: 1.20.1 ([read setup guide](/doc/SET_UP.md))
* Fabric Loader: >=0.14.21 ([download Fabric Loader](https://fabricmc.net/use/installer/))
* Fabric API: 0.84.0+1.20.1 ([download Fabric API](https://cdn.modrinth.com/data/P7dR8mSH/versions/FLGCXPFi/fabric-api-0.84.0%2B1.20.1.jar))
* Forge: 1.20.1-47.2.17 ([download Forge installer](https://maven.minecraftforge.net/net/minecraftforge/forge/1.20.1-47.2.17/forge-1.20.1-47.2.17-installer.jar))
Expand All @@ -34,7 +33,7 @@ Compatibility For 1.19.3

Haven't changed since [1.0.1-beta.2 for 1.19.3](https://github.com/khanshoaib3/minecraft-access/releases/tag/v1.0.1-beta.2) (released on 2023 June 18).

* Minecraft: 1.19.3 ([read setup guide](/doc/SET_UP_ON_WINDOWS.md))
* Minecraft: 1.19.3 ([read setup guide](/doc/SET_UP.md))
* Fabric Loader: >=0.14.21 ([download Fabric Loader](https://fabricmc.net/use/installer/))
* Fabric API: 0.76.1+1.19.3 ([download Fabric API](https://cdn.modrinth.com/data/P7dR8mSH/versions/jyKnHEDY/fabric-api-0.76.1%2B1.19.3.jar))
* Forge: 1.19.3-44.1.23 ([download Forge installer](https://maven.minecraftforge.net/net/minecraftforge/forge/1.19.3-44.1.0/forge-1.19.3-44.1.0-installer.jar))
Expand Down
4 changes: 3 additions & 1 deletion doc/SET_UP.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ Follow the [instruction](https://github.com/jordansissel/xdotool#installation) t

## Other Pages

* [Home](/README.md)
* [Features](/doc/FEATURES.md)
* [Keybindings](/doc/KEYBINDINGS.md)
* [Configuration](/doc/CONFIG.md)
* [FAQ](/doc/FAQ.md)
* [FAQ](/doc/FAQ.md)
* [Good Resources](/doc/GOOD_RESOURCES.md)
Loading
Loading