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.

Sign up for GitHub

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

Jump to bottom

Add some details about upgrading game in setup guide #236

Merged
merged 2 commits into from
Jan 12, 2024
Merged

Add some details about upgrading game in setup guide #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a055e7b
Add some details about upgrading game in setup guide
boholder Jan 11, 2024
34c6aaf
Add guide about asking for help in FAQ
boholder Jan 11, 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
53 changes: 50 additions & 3 deletions doc/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
5. [Has this mod been uploaded to mod platforms?](#has-this-mod-been-uploaded-to-mod-platforms)
6. [Is this mod supports XX language?](#is-this-mod-supports-xx-language)
7. [How can I contribute to I18N?](#how-can-i-contribute-to-i18n)
8. [What information the others need when I ask them for help?](#what-information-the-others-need-when-i-ask-them-for-help)

## Is the mod enough to play the game normally?

Expand Down Expand Up @@ -39,11 +40,11 @@ We stick to the pure client-side strategy for now, since you need to install a s

## Why nobody answers my questions in Discord?

Sorry for the inconvenience. Here are some self-help materials to help you.
Sorry for the inconvenience. Here are some self-help materials.
If you have any question about installing, please read the [set-up guide](/doc/SET_UP.md).
If you have any question about original game functions, please search on the [wiki](https://minecraft.wiki/w/Special:Search?scope=internal) or just google it.
If you want to learn to play the game, there are [some detailed text tutorials on wiki](https://minecraft.wiki/w/Tutorials), you can also listen [Pixlriffs's Minecraft Survival Guide](https://www.youtube.com/watch?v=VfpHTJsn9I4&list=PLgENJ0iY3XBjmydGuzYTtDwfxuR6lN8KC) on YouTube, or just google the question and search answers on forums.
If you have any question about this ![img.png](img.png)mod, please read the [manual](/README.md).
If you have any question about this mod, please read the [manual](/README.md).

## Why this mod is updated slowly / the feature I asked was not released in the new version?

Expand All @@ -62,4 +63,50 @@ See [I18N Fallback Mechanism Feature](/doc/FEATURES.md#i18n-fallback-mechanism).

## How can I contribute to I18N?

We manage the translation of this mod in [another GitHub repository](https://github.com/khanshoaib3/minecraft-access-i18n#minecraft-access-i18n), take a look.
We manage the translation of this mod in [another GitHub repository](https://github.com/khanshoaib3/minecraft-access-i18n#minecraft-access-i18n), take a look.

## What information the others need when I ask them for help?

Chose the section that fits your progress:

### Haven't run the game yet

I assume you have taken a look at the [setup guide](/doc/SET_UP.md).

If you are walking on a path that the setup guide isn't mentioned (for example, you're not purchasing the game from the official site), developers can't help you since they just can't walk on the same path.
But you can still ask users in [Discord server](https://discord.gg/yQjjsDqWQX) (mc-help channel) for help with enough description, maybe there are users that solved that problem before.
Then we can update this path into the setup guide so everyone in the Future can benefit from it.

If you experience is not same as the setup guide describes you should expect when you're completely following the guide, it means there is something wrong or misleading in the setup guide.
Describe which step you currently are, what you find out is not same as the guide says.
I believe through talking we can find out what's wrong together and fix it.

### The game crushed when I start it from launcher

Great! Believe it or not, it's easier to be solved than "running but abnormal", game crushed because it KNEW something is wrong, better than knowing nothing.
There would be log files under the `logs` folder in your `.minecraft` folder, developers need the `debug.log` file, it contains enough information to find out where is the problem, please upload it to wherever that developers can view.
If the crush pop up dialog says something about "mod incompatibility", please refer [this section](/doc/SET_UP_ON_WINDOWS.md#upgrade-the-game-and-mods) in the setup guide.

### The game running but abnormal

#### Can't hear the game narration

Sorry but we don't have enough knowledge to solve this problem on Linux, we haven't got this type of report.

If you're in Windows, please check:

* There is no missing ["tolk" files](/doc/SET_UP_ON_WINDOWS.md#additional-installation-for-windows) under the game folder.
* You have set the ["Narrator"](https://minecraft.wiki/w/Options#Chat_Settings) game setting (under "Options", "Chat Settings") to "All" choice.

now open the launcher and start the game, when you're at the main screen (in which has "singleplayer game", "multiplayer game"...), close your screen reader and open built-in [Windows Narrator](https://support.microsoft.com/en-us/windows/complete-guide-to-narrator-e4397a0d-ef4f-b386-d8ae-c172f109bdb1) feature. Can you hear the menu selecting narration through Windows Narrator? If so the problem is in your screen reader, maybe the Narrator setting is wrong (for example, you need to close NVDA's keyboard narration setting since it will cover the narration from this mod), or there is a compatibility problem between it and "tolk".

#### This mod doesn't work like expected

I assume you have searched on [wiki](https://minecraft.wiki) or Internet to make sure you've understood the original game part of your question.
Please provide these information to developers in "mc-issues" channel:

* Your operation
* What you expected or what the mod manual premises
* What feedback the game and mod gave you

It might be a bug of this mod, or something in mod manual is misleading, or you misunderstand how the game works like.
22 changes: 11 additions & 11 deletions doc/SET_UP_ON_WINDOWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Below are system requirements from [the official website](https://www.minecraft.
> And yeah, most servers have this authentication turned on.
>
> It is theoretically possible to install mods for pirated Minecraft, but I don't know how to do it,
> and for your and your computer's safety we don't recommend playing pirated games, so lets not discuss this further.
> and for your and your computer's safety we don't recommend playing pirated games, so lets not discuss this further, google it yourself if you insist.

There are two editions of Minecraft: Java Edition and Bedrock Edition.
This Mod is only available for the Java Edition.
Expand Down Expand Up @@ -95,11 +95,10 @@ So if you have problem with Microsoft Store service, please download the older o
The launcher installer is a normal executable file, run it and wait for the finish.
If the installation is successful, you will now have a new application called `Minecraft Launcher`.

I'm not sure if the next steps require starting the launcher once first to get it to initialize something.
So try starting the launcher, then start whatever version of the Java Edition Minecraft (the latest version by default).
The next steps require starting the launcher once first to let it generate the game folder, so try [starting the launcher](#start-the-game), then start whatever version of the Java Edition Minecraft (the latest version by default).
Something may need to be prepared every time the launcher starts, especially at the first time the whole game need to be downloaded.
This may take a few minutes, and you can listen to the screen reader's progress bar sound effect to know the progress.
At the first time you start it requires you to sign in with your Microsoft account.
At the first time you start the launcher it requires you to sign in with your Microsoft account.

## Choose and Install the Mod Framework

Expand Down Expand Up @@ -152,7 +151,7 @@ Try to switch to English input method first, if the problem still persists, plea
Start the installer, a window pops up for you to choose the installation configurations:

1. The `Client` tab is selected by default, yeah we want to install the client, don't change it.
2. The first combo box is for selecting the game version you want to install, please refer to the current game version that supported by this mod on [releases page](https://github.com/khanshoaib3/minecraft-access/releases).
2. The first combo box is for selecting the game version you want to install, please refer to the current game version that supported by this mod on [releases page](https://github.com/khanshoaib3/minecraft-access/releases) (under `Mod Version Compatibility` section), and change the combo box to select that game version.
3. Next is a checkbox for showing game snapshot versions, just ignore it, it's for mod developers.
4. The second combo box is for selecting the Fabric loader version, the latest version is selected by default and no need to change.
5. Then there is an input field for specifying the installation location, normally the installer will automatically recognize the official loader's folder,
Expand All @@ -167,9 +166,9 @@ Start the installer, a window pops up for you to choose the installation configu

#### Download the Forge

Reports have been received that higher versions of Forge that are compatible with the game version may not be compatible with the mod, so it is recommended to download the tested version of Forge with link in the [releases page](https://github.com/khanshoaib3/minecraft-access/releases) (under `Mod Version Compatibility` section).
Forge requires you to select the right version of the game at the time of download the installer, please refer to the current game version that supported by this mod on releases page.
If you want to download the latest version of Forge for some reason, [here is the download page for the Forge](https://files.minecraftforge.net/net/minecraftforge/forge/).
Forge requires you to select the right version of the game at the time of download the installer.
Reports have been received that higher versions of Forge that are compatible with the game version may not be compatible with this mod (this mod is always built on one specific Forge version), so it is recommended to download the tested version of Forge with link in the [releases page](https://github.com/khanshoaib3/minecraft-access/releases) (under `Mod Version Compatibility` section).
If you still want to download the latest version of Forge for some reason, [here is the download page for that version of Forge](https://files.minecraftforge.net/net/minecraftforge/forge/).
Select the `Installer` button under the `Download Recommended` sector.
Then the website will redirect you to a Minecraft server provider's advertising page, in which you'll find a `SKIP` button, click it to trigger the real downloading process.
An executable jar file will be downloaded, named as `forge-<game-version>-<forge-version>-installer.jar`, for example `forge-1.20.1-47.1.0-installer.jar`.
Expand Down Expand Up @@ -278,7 +277,10 @@ If the game crashes and a bunch of error logs pop up, the biggest probability is

## Upgrade the Game and Mods

Recall what is mentioned above:
Upgrade the game is simple, for [Fabric](#install-the-fabric), change the preferring installing game version in Fabric installer screen, for [Forge](#install-the-forge), download another installer for the game version you want and install it.
You need to check all mod files in the `mods` folder for compatibility with the new game version, and replace or remove incompatible mods.

Now let's talk about how to upgrade mods, recall what is mentioned above:

1. The mod framework itself and mods of Fabric and Forge are not compatible with each other.
2. The same framework for different game versions are not compatible with mod files which support other game versions.
Expand All @@ -294,8 +296,6 @@ According to these conditions, if you want to upgrade some mods version while ke
For mods that have dependencies like this mod, you also need to be aware of that whether the version of dependent mods have changed.
For example, when upgrading this mod, you should be also aware the version changes of `Fabric Api` and `Architectury Api` mods.

If you want to update the game version, you need to check all mod files in the `mods` folder for compatibility with the new game version, and replace or remove incompatible mods.

Another situation that causes the game to crash or misbehave is conflict between mods, which is difficult to reflect in the error log because it is hard to predict.
For this type of error, there is a simple, common, cumbersome, no-better-choice method for all modded games: move all mod files into a temporal folder, then add them back one by one, try to start the game every time you move back a file.

Expand Down