Skip to content

Commit d907415

Browse files
sgmedevsgmedev
authored
Merge pull request #1 from Molitvan/dev
Add content to the landing page
2 parents a9b07ac + c7a510c commit d907415

5 files changed

Lines changed: 267 additions & 40 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Minecraft Access landing page
2+
3+
The code for the landing page of Minecraft Access available [here](https://mcaccess.org).
4+
5+
This does not include [the documentation site](https://docs.mcaccess.org). That is managed in [the main Minecraft Access repository](https://github.com/minecraft-access/minecraft-access) under the docs folder.

‎content/_index.html‎

Lines changed: 48 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,54 @@
11
---
22
Title: "Home"
33
---
4-
<div class="centre sparse">
5-
<h1>Minecraft Access</h1>
4+
<div>
5+
<div class="centre sparse">
6+
<h1>Minecraft Access</h1>
7+
<p>
8+
A Minecraft mod for Fabric/Neoforge that helps blind and low vision players play the game.
9+
</p>
10+
11+
<a class="cta" href="{{% relref "downloads" %}}">Download</a>
12+
<a class="cta" href="https://docs.mcaccess.org/">Documentation</a>
13+
</div>
14+
15+
<h1>What is it?</h1>
616
<p>
7-
A mod for minecraft java (fabric/neoforge) that specifically helps visually impaired players play Minecraft.
17+
Minecraft Access enhances accessibility for blind and low vision players by using speech and sound cues to provide crucial in-game information. It enables blind and low vision players to experience the game in a way that was previously impossible.
18+
</p>
19+
20+
<h1>Features</h1>
21+
<p>Minecraft Access has a lot of features that enhance accessibility. Some of them include:</p>
22+
<ul>
23+
<li>Read blocks you're facing</li>
24+
<li>Sound cues for locating points of interests like mobs and ores</li>
25+
<li>Full menu narration, including of all in-game screens</li>
26+
<li>Much, much more</li>
27+
<li><a href="https://docs.mcaccess.org/features">See the full feature list</a></li>
28+
</ul>
29+
30+
<h1>How to install?</h1>
31+
<p>
32+
Installing Minecraft Access is as easy as installing any other mod:
33+
<ul>
34+
<li>Install Fabric or Neoforge</li>
35+
<li><a href="{{% relref "downloads" %}}">Download Minecraft Access</a></li>
36+
<li>Place it in the mods folder</li>
37+
<li>Launch the game and enjoy</li>
38+
</ul>
39+
For detailed step-by-step installation instructions, check out <a href="https://docs.mcaccess.org/setup/basic">our setup guide</a>.
40+
</p>
41+
42+
<h1>Frequently Asked Questions</h1>
43+
<p>
44+
Check out <a href="{{% relref "/faq" %}}">this page</a> where we answer some of the most commonly asked questions.
45+
</p>
46+
47+
<h1>Our official Minecraft server</h1>
48+
<p>
49+
We also run a fully accessible Minecraft server with various gameplay and quality of life features not found in the vanilla game. <a href="https://server.mcaccess.org">Learn more</a>
50+
</p>
51+
<p>
52+
Feel free to join at <strong>server.mcaccess.org</strong>
853
</p>
9-
<a class="cta" href="https://docs.mcaccess.org/downloads">Download</a>
10-
<a class="cta" href="https://docs.mcaccess.org/">Documentation</a>
11-
<a class="cta" href="https://discord.gg/yQjjsDqWQX">Discord</a>
12-
<a class="cta" href="https://github.com/minecraft-access/minecraft-access/">GitHub</a>
1354
</div>

‎content/downloads.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "Downloads"
3+
---
4+
5+
# Downloads
6+
7+
Minecraft Access is available for Fabric or Neoforge on Windows, Linux and Mac.
8+
9+
If you're on Windows, see the [Fabric setup guide](https://docs.mcaccess.org/setup/basic) (recommended) or the [Neoforge setup guide](https://docs.mcaccess.org/setup/advanced).
10+
11+
If you're on MacOS, see the [MacOS setup guide](https://docs.mcaccess.org/setup/macos)
12+
13+
Note: Currently there is no setup guide for Linux
14+
15+
Minecraft Access is also a part of the [Visually Impaired Access Mods modpack](https://modrinth.com/modpack/vi-access) available on Modrinth. See the [modpack setup guide](https://docs.mcaccess.org/setup/modpack).
16+
17+
# Download Links
18+
- [Download from GitHub](https://github.com/khanshoaib3/minecraft-access/releases/)
19+
- [Download from CurseForge](https://www.curseforge.com/minecraft/mc-mods/blind-accessibility)
20+
- [Download from Modrinth](https://modrinth.com/mod/minecraft-access)

‎content/faq.md‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
title: "Frequently Asked Questions"
3+
---
4+
5+
## Is the mod enough to play the game normally?
6+
7+
Yes and no.
8+
Overall, the mod is enough for basic playing,
9+
but that doesn't mean you can play it as well as a sighted player, for now at least.
10+
11+
We can claim that the current functionality of the mod is enough for normal play,
12+
given that even totally blind users have already played with the help of this mod.
13+
Some of them are publishing their experiences,
14+
you can listen to the uploaded videos at:
15+
[Logic Pro X Gaming](https://www.youtube.com/@LogicProXGaming/search?query=minecraft) and [TrueBlindGaming](https://www.youtube.com/@TrueBlindGaming/search?query=minecraft).
16+
17+
The mod primarily borrows the help of a screen reader to describe the game interface
18+
and incorporates sound cues to provide orientation perception in this 3D world.
19+
Currently,
20+
the Mod has implemented such functions as `Read Crosshair` (read out blocks and creatures you're pointing at),
21+
`100% accessibility for all screens`, `Camera Controls`, and `Mouse Simulation` with keyboard,
22+
`Points of Interest`
23+
(scan nearby special blocks and creatures and lock on them),
24+
and a new F4 `Narrator Menu` which contains assistant functions like `Read Light Level`,
25+
`Find Closest Water Source`, etc.
26+
27+
You can play the game within the keyboard's main typing part (which means a number pad isn't necessary),
28+
without a mouse.
29+
You can walk around the world, gather materials, farm the land, raise animals, mine,
30+
fight monsters, and even build buildings and Redstone machines.
31+
32+
The `No` part of the answer contains two perspectives.
33+
34+
First, this mod doesn't achieve 100% accessibility.
35+
For example, you'll find rowing a boat is challenging (since the relevant feature hasn't been implemented yet).
36+
You also can't directly recognize blocks that are placed together as a structure
37+
(since you can't see the entire appearance of a group of blocks, and there's very little this mod can do about that).
38+
This mod is gradually adding new features, but it's highly unlikely that Minecraft will ever achieve 100% accessibility.
39+
40+
Second, Minecraft, although it has a large number of players, is not easy to get started with.
41+
You'll need to learn a lot of new concepts and knowledge to play it.
42+
You can find some good tutorials in [this page]("https://docs.mcaccess.org/good-resources#tutorial-resources").
43+
44+
So if you haven't bought the game yet and know little about Minecraft, think again before paying.
45+
46+
## Can this mod be used to play multiplayer servers?
47+
48+
Yeah! This mod is a pure client-sided mod, which means you can play either single player or multiplayer with this mod without additional operations.
49+
However, this also limits what the mod can do, and most of the possible changes that are powerful and convenient for visually impaired players often involve modifying server-side logic.
50+
The mod is sticking to a pure client-side strategy for now.
51+
Since if the mod was for both server-side and client-side,
52+
that would mean you would have to install a mod on the server.
53+
You can't achieve this if the server doesn’t belong to you.
54+
55+
## Why is nobody answering my questions in the Discord?
56+
57+
Sorry for the inconvenience. Here are some self-help materials.
58+
If you have any questions about installing, please read the [set-up guide](https://docs.mcaccess.org/setup/basic).
59+
If you have any questions about original game functions, please search on the [wiki](https://minecraft.wiki/w/Special:Search?scope=internal) or just google it.
60+
If you want to learn to play the game,
61+
there are some detailed text tutorials on the [wiki](https://minecraft.wiki/w/Tutorials).
62+
You can also listen to [Pixlriffs's Minecraft Survival Guide](https://www.youtube.com/watch?v=VfpHTJsn9I4&list=PLgENJ0iY3XBjmydGuzYTtDwfxuR6lN8KC) on YouTube,
63+
or just google the question and search for answers on forums.
64+
If you have any questions about this mod, please read the [documentation](https://docs.mcaccess.org).
65+
66+
## Why is this mod updated slowly / the feature I asked for wasn't released in the new version?
67+
68+
Uh, maintaining or updating this mod is a volunteer effort.
69+
There are currently only two active developers.
70+
Any type of contribution is welcome, please go to the [issues page](https://github.com/khanshoaib3/minecraft-access/issues) for more details.
71+
If you know developers who might be willing to help contribute to this mod, please send them information about this mod and encourage them to do so.
72+
73+
## Has this mod been uploaded to mod platforms?
74+
75+
Yes, it has been uploaded to Modrinth as [Minecraft Access](https://modrinth.com/mod/minecraft-access) and CurseForge as [Blind Accessibility](https://www.curseforge.com/minecraft/mc-mods/blind-accessibility).
76+
77+
## Does this mod support X language?
78+
79+
See the [I18N Fallback Mechanism](https://docs.mcaccess.org/features#i18n-fallback-mechanism) feature.
80+
81+
## How can I contribute to I18N?
82+
83+
We manage the translation of this mod with [Weblate](https://hosted.weblate.org/engage/minecraft-access/), take a look.
84+
85+
## Self-help guide for abnormal situations
86+
87+
Choose the section that fits your progress:
88+
89+
### Haven't run the game yet
90+
91+
I assume you have taken a look at the [setup guide](https://docs.mcaccess.org/setup/basic).
92+
93+
If you’re on a path that the setup guide doesn't mention
94+
(for example, you're not purchasing the game from the official site),
95+
developers can't help you since they can't follow the same path.
96+
But you can still ask users in the [Playability Discord server](https://discord.gg/yQjjsDqWQX)
97+
(mc-help channel) for help,
98+
maybe there are users that have already solved your problem before.
99+
Then we can add your question and the working solution to the setup guide so everyone in the Future can benefit from it.
100+
101+
If your experience is different from the setup guide describes,
102+
it means there is something wrong or misleading in the setup guide.
103+
Describe which step you’re currently on and what you found that is not the same as the guide says.
104+
Through talking to the developers and community of this mod, they can help figure out what's wrong and help you fix it.
105+
106+
### The game crashed when I started it from the launcher
107+
108+
Great!
109+
Believe it or not, this is easier to solve than `abnormally running`,
110+
as the game crashed because it KNEW something was wrong, better than knowing nothing.
111+
If the crash pop up dialog says something about `mod incompatibility`,
112+
please refer to [this section](https://docs.mcaccess.org/setup/basic#update-the-game-and-mods) in the basic setup guide.
113+
114+
If you’re using Fabric, there will be crash report files under the `crash-reports` folder in your `.minecraft` folder,
115+
developers need the latest `crash-...` file.
116+
If you’re using NeoForge, there will be log files under the `logs` folder in your `.minecraft` folder,
117+
developers need the `debug.log` file.
118+
Please upload it to wherever the developers can view it,
119+
for example, you can upload it to Discord channels while asking for help.
120+
121+
### The game is running but acts abnormal
122+
123+
#### Can't hear the game narration
124+
125+
If you're using Windows, please check:
126+
127+
1. There are no missing Tolk files under the game folder.
128+
2. You're using one of Tolk's [supported screen readers](https://github.com/ndarilek/tolk?tab=readme-ov-file#supported-screen-readers), please note that Windows built-in Narrator is not supported by tolk.
129+
3. You’ve set the [`Narrator`](https://minecraft.wiki/w/Options#Chat_Settings) game setting (under `Options`, `Chat Settings`) to the `Narrator narrates All` choice.
130+
131+
Now open the launcher and start the game,
132+
when you're at the main screen (which has `singleplayer game`, `multiplayer game`...),
133+
disable your screen reader
134+
and enable the built-in [Windows Narrator](https://support.microsoft.com/en-us/windows/complete-guide-to-narrator-e4397a0d-ef4f-b386-d8ae-c172f109bdb1) feature.
135+
Can you hear the menu selection narration through Windows Narrator?
136+
If so the problem is in your screen reader, maybe the Narrator setting is wrong (for example, you should disable NVDA's
137+
speak typed characters setting since it will interrupt the narration of this mod),
138+
or there is a compatibility problem between it and `tolk`.
139+
140+
#### This mod doesn't work as expected
141+
142+
I will assume you have searched on the [Minecraft wiki](https://minecraft.wiki) or the Internet to make sure you understand the original game part of your question.
143+
Please provide, at minimum, this information in the `mc-issues` channel of the Playability Discord:
144+
145+
* Your operation
146+
* What you expected to happen or what mod docs step you were on
147+
* What feedback the game and mod gave you
148+
* In case you’re asked to provide log files: you can find them under the `logs` folder in your `.minecraft` folder, developers need the `debug.log` file, please upload it to where you asked your question.
149+
150+
It might be a bug in this mod, something in the mod docs is misleading, or you misunderstand how the game works.

‎layouts/_default/baseof.html‎

Lines changed: 44 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,69 @@
11
<!DOCTYPE html>
22
<html lang="{{- .Site.LanguageCode -}}">
3+
34
<head>
45
<meta charset="utf-8">
56
<meta name="viewport" content="width=device-width, initial-scale=1.0">
67
<title>{{- block "title" . -}}{{- default .Page.Path .Page.Title }} | {{ .Site.Title -}}{{- end -}}</title>
78
{{- with resources.Get "main.sass" | toCSS | minify | fingerprint -}}
8-
<link rel="stylesheet" href="{{- .RelPermalink -}}" integrity="{{- .Data.Integrity -}}">
9+
<link rel="stylesheet" href="{{- .RelPermalink -}}" integrity="{{- .Data.Integrity -}}">
910
{{- end -}}
1011
{{- with resources.Get "logo.png" | fingerprint -}}
11-
<link rel="shortcut icon" href="{{- .RelPermalink -}}" integrity="{{- .Data.Integrity -}}">{{- /**/ -}}
12-
<meta property="og:image" content="{{- .RelPermalink -}}">
12+
<link rel="shortcut icon" href="{{- .RelPermalink -}}" integrity="{{- .Data.Integrity -}}">{{- /**/ -}}
13+
<meta property="og:image" content="{{- .RelPermalink -}}">
1314
{{- end -}}
1415
<meta property="theme-color" media="(prefers-color-scheme: dark)" content="#267547">{{- /**/ -}}
1516
<meta property="theme-color" media="(prefers-color-scheme: light)" content="#40a849">{{- /**/ -}}
1617
<meta property="og:image:alt"
17-
content="Minecraft Access logo. A retro games controller graphic over a blurred background of a snowy mountain village next to a spruce forrest.">
18+
content="Minecraft Access logo. A retro games controller graphic over a blurred background of a snowy mountain village next to a spruce forrest.">
1819
{{- template "_internal/opengraph.html" . -}}
1920
{{- template "_internal/schema.html" . -}}
2021
{{- template "_internal/twitter_cards.html" . -}}
2122
</head>
23+
2224
<body>
23-
<header>
24-
{{- with resources.Get "logo.png" -}}
25-
<img class="logo"
26-
src="{{- .RelPermalink -}}"
27-
alt="Logo: A retro games controller over a blurred snowy mountain village next to a spruce forrest.">
28-
{{- end -}}
29-
<span>{{- .Site.Title -}}</span>
30-
<nav>
31-
<ul>
32-
<li><a href="https://docs.mcaccess.org/downloads">Download</a></li>
33-
<li><a href="https://docs.mcaccess.org/">Docs</a></li>
34-
</ul>
35-
</nav>
36-
</header>
37-
<main>
38-
<div>
39-
{{- block "main" . -}}{{- end -}}
40-
</div>
41-
</main>
42-
<footer>
43-
{{- with getenv "GITHUB_REPOSITORY" -}}
25+
<header>
26+
{{- with resources.Get "logo.png" -}}
27+
<img class="logo" src="{{- .RelPermalink -}}"
28+
alt="Logo: A retro games controller over a blurred snowy mountain village next to a spruce forrest.">
29+
{{- end -}}
30+
<span>{{- .Site.Title -}}</span>
31+
<nav>
32+
<ul>
33+
<li><a href="{{ .Site.Home.Permalink }}">Home</a></li>
34+
{{ with .Site.GetPage "downloads" }}
35+
<li><a href="{{ .RelPermalink }}">Download</a></li>
36+
{{ end }}
37+
<li><a href="https://docs.mcaccess.org/">Docs</a></li>
38+
{{ with .Site.GetPage "faq" }}
39+
<li><a href="{{ .RelPermalink }}">FAQ</a></li>
40+
{{ end }}
41+
<li><a href="https://github.com/minecraft-access/minecraft-access">GitHub</a></li>
42+
<li><a href="https://discord.gg/yQjjsDqWQX">Discord</a></li>
43+
<li><a href="https://server.mcaccess.org">Minecraft Server</a></li>
44+
</ul>
45+
</nav>
46+
</header>
47+
<main>
48+
<div>
49+
{{- block "main" . -}}{{- end -}}
50+
</div>
51+
</main>
52+
<footer>
53+
{{- with getenv "GITHUB_REPOSITORY" -}}
4454
<p>
4555
<a href="https://github.com/{{- . -}}">{{- . -}}</a>
4656
{{- with getenv "GITHUB_SHA" }}
47-
@ <a href="https://github.com/{{- getenv "GITHUB_REPOSITORY" -}}/commit/{{- . -}}">
48-
<abbr title="{{- . -}}">{{- . | truncate 9 "" -}}</abbr>
49-
</a>
57+
@ <a href="https://github.com/{{- getenv "GITHUB_REPOSITORY" -}}/commit/{{- . -}}">
58+
<abbr title="{{- . -}}">{{- . | truncate 9 "" -}}</abbr>
59+
</a>
5060
{{- end -}}
5161
</p>
52-
{{- end -}}
53-
<p>
54-
NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.
55-
</p>
56-
</footer>
62+
{{- end -}}
63+
<p>
64+
NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.
65+
</p>
66+
</footer>
5767
</body>
68+
5869
</html>

0 commit comments

Comments
 (0)