Skip to content

Commit eb615ae

Browse files
committed
Update guides/faq for new launcher, create archive section w/ redirect
1 parent 07424b9 commit eb615ae

File tree

10 files changed

+97
-36
lines changed

10 files changed

+97
-36
lines changed

config/_default/hugo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
title = "OpenFusion"
22
baseurl = "http://localhost/"
33
canonifyURLs = false
4-
disableAliases = true
4+
disableAliases = false
55
disableHugoGeneratorInject = true
66
# disableKinds = ["taxonomy", "term"]
77
enableEmoji = true

content/docs/archive/_index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Archive"
3+
description: ""
4+
summary: ""
5+
draft: false
6+
weight: 1000
7+
toc: true
8+
sidebar:
9+
collapsed: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Quick Start (Legacy Client)"
3+
slug: "quick-start"
4+
description: ""
5+
summary: ""
6+
date: 2023-09-07T16:04:48+02:00
7+
lastmod: 2023-09-07T16:04:48+02:00
8+
draft: false
9+
weight: 1010
10+
toc: true
11+
seo:
12+
title: "" # custom title (optional)
13+
description: "" # custom description (recommended)
14+
canonical: "" # custom canonical URL (optional)
15+
noindex: false # false (default) or true
16+
---
17+
18+
{{< callout context="caution" title="Caution" icon="outline/alert-triangle" >}}
19+
This is a guide for the legacy software, OpenFusionClient.
20+
21+
For instructions regarding the modern launcher, see [Quick Start](/docs/guides/quick-start).
22+
{{< /callout >}}
23+
24+
### Method A: Installer (Easiest)
25+
1. Download the client installer by clicking [here](https://github.com/OpenFusionProject/OpenFusion/releases/download/1.6/OpenFusionClient-1.6-Installer.exe) - choose to run the file.
26+
2. After a few moments, the client should open: you will be given a choice between two public servers by default. Select the one you wish to play and click connect.
27+
3. To create an account, simply enter the details you wish to use at the login screen then click Log In. Do *not* click register, as this will just lead to a blank screen.
28+
4. Make a new character, and enjoy the game! Your progress will be saved automatically, and you can resume playing by entering the login details you used in step 3.
29+
30+
### Method B: Standalone .zip file
31+
1. Download the client from [here](https://github.com/OpenFusionProject/OpenFusion/releases/download/1.6/OpenFusionClient-1.6.zip).
32+
2. Extract it to a folder of your choice. Note: if you are upgrading from an older version, it is preferable to start with a fresh folder rather than overwriting a previous install.
33+
3. Run OpenFusionClient.exe - you will be given a choice between two public servers by default. Select the one you wish to play and click connect.
34+
4. To create an account, simply enter the details you wish to use at the login screen then click Log In. Do *not* click register, as this will just lead to a blank screen.
35+
5. Make a new character, and enjoy the game! Your progress will be saved automatically, and you can resume playing by entering the login details you used in step 4.
36+
37+
Instructions for getting the client to run on Linux through Wine can be found [here](/docs/guides/running-on-linux/).
38+
39+
If you run into any issues, try checking [the FAQ](/docs/reference/frequently-asked-questions) or ask for assistance in our Discord server.
40+

content/docs/guides/running-on-linux.md renamed to content/docs/archive/running-on-linux.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
title: "Running on Linux"
2+
aliases: ['/docs/guides/running-on-linux/']
3+
title: "Running on Linux (Legacy Client)"
4+
slug: "running-on-linux"
35
description: ""
46
summary: ""
57
date: 2024-07-14T18:32:54-05:00
68
lastmod: 2024-07-14T18:32:54-05:00
79
draft: false
8-
weight: 730
10+
weight: 1020
911
toc: true
1012
seo:
1113
title: "" # custom title (optional)
@@ -14,6 +16,12 @@ seo:
1416
noindex: false # false (default) or true
1517
---
1618

19+
{{< callout context="caution" title="Caution" icon="outline/alert-triangle" >}}
20+
This is a guide for the legacy software, OpenFusionClient.
21+
22+
For instructions regarding the modern launcher, see [Quick Start](/docs/guides/quick-start).
23+
{{< /callout >}}
24+
1725
While the OpenFusion server supports both Windows and Linux (and other Unix-like systems), the game client natively supports only Windows because of the NPAPI Unity Web Player plugin needed to run the game.
1826
Nevertheless, the client runs very well in Wine if configured properly.
1927

content/docs/development/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: "Development"
33
description: ""
44
summary: ""
5-
date: 2023-09-07T16:12:37+02:00
6-
lastmod: 2023-09-07T16:12:37+02:00
75
draft: false
86
weight: 999
97
toc: true

content/docs/guides/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: "Guides"
33
description: ""
44
summary: ""
5-
date: 2023-09-07T16:06:50+02:00
6-
lastmod: 2023-09-07T16:06:50+02:00
75
draft: false
86
weight: 800
97
toc: true

content/docs/guides/hosting-a-server.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Hosting a Server"
33
description: ""
44
summary: ""
55
date: 2024-07-14T17:57:37-05:00
6-
lastmod: 2024-10-10T17:19:07+02:00
6+
lastmod: .Lastmod
77
draft: false
88
weight: 720
99
toc: true
@@ -14,12 +14,12 @@ seo:
1414
noindex: false # false (default) or true
1515
---
1616

17-
1. Grab `OpenFusionServer-1.6-Original.zip` or `OpenFusionServer-1.6-Academy.zip` from [here](https://github.com/OpenFusionProject/OpenFusion/releases/tag/1.6).
17+
1. Grab `OpenFusionServer-X-Original.zip` or `OpenFusionServer-X-Academy.zip` from [here](https://github.com/OpenFusionProject/OpenFusion/releases/latest), where `X` corresponds to your operating system.
1818
2. Extract it to a folder of your choice, then run `winfusion.exe` (Windows) or `fusion` (Linux) to start the server.
19-
3. Add a new server to the client's list:
19+
3. Add a new Simple Server to the launcher's list:
2020
1. For Description, enter anything you want. This is what will show up in the server list.
2121
2. For Server IP, enter the IP address and port of the login server. If you're hosting and playing on the same PC, this would be `127.0.0.1:23000`.
2222
3. Lastly Game Version - select `beta-20100104` if you downloaded the original zip, or `beta-20111013` if you downloaded the academy zip.
23-
5. Once you've added the server to the list, connect to it and log in. If you're having trouble with this, refer to steps 4 and 5 of the [quick start](/docs/guides/quick-start).
23+
4. Once you've added the server to the list, connect to it and log in. If the account does not exist yet, it will be created automatically.
2424

2525
If you run into any issues, try checking [the FAQ](/docs/reference/frequently-asked-questions) or ask for assistance in our Discord server.

content/docs/guides/quick-start.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Quick Start"
33
description: ""
44
summary: ""
55
date: 2023-09-07T16:04:48+02:00
6-
lastmod: 2023-09-07T16:04:48+02:00
6+
lastmod: .Lastmod
77
draft: false
88
weight: 710
99
toc: true
@@ -14,20 +14,26 @@ seo:
1414
noindex: false # false (default) or true
1515
---
1616

17+
## Windows 10 / 11
18+
1719
### Method A: Installer (Easiest)
18-
1. Download the client installer by clicking [here](https://github.com/OpenFusionProject/OpenFusion/releases/download/1.6/OpenFusionClient-1.6-Installer.exe) - choose to run the file.
19-
2. After a few moments, the client should open: you will be given a choice between two public servers by default. Select the one you wish to play and click connect.
20-
3. To create an account, simply enter the details you wish to use at the login screen then click Log In. Do *not* click register, as this will just lead to a blank screen.
21-
4. Make a new character, and enjoy the game! Your progress will be saved automatically, and you can resume playing by entering the login details you used in step 3.
20+
1. Download the launcher installer by clicking [here](https://github.com/OpenFusionProject/OpenFusionLauncher/releases/latest/download/OpenFusionLauncher-Windows-Installer.exe) - choose to run the file.
21+
2. After a few moments, the launcher should open: you will be given a choice between two public servers by default. Select the one you wish to play and click connect.
22+
3. To create an account, switch to the 'Register' tab and enter in your details, then click the Register button. If you have an account for the server already, you can enter it inside of the 'Log In' tab.
23+
4. Make a new character, and enjoy the game! Your progress will be saved automatically, and you can resume playing by entering the login details you used in step 3. Make sure to verify your email if you want to enable password recovery!
2224

2325
### Method B: Standalone .zip file
24-
1. Download the client from [here](https://github.com/OpenFusionProject/OpenFusion/releases/download/1.6/OpenFusionClient-1.6.zip).
26+
1. Download the launcher from [here](https://github.com/OpenFusionProject/OpenFusionLauncher/releases/latest/download/OpenFusionLauncher-Windows-Portable.zip).
2527
2. Extract it to a folder of your choice. Note: if you are upgrading from an older version, it is preferable to start with a fresh folder rather than overwriting a previous install.
26-
3. Run OpenFusionClient.exe - you will be given a choice between two public servers by default. Select the one you wish to play and click connect.
27-
4. To create an account, simply enter the details you wish to use at the login screen then click Log In. Do *not* click register, as this will just lead to a blank screen.
28-
5. Make a new character, and enjoy the game! Your progress will be saved automatically, and you can resume playing by entering the login details you used in step 4.
28+
3. Run OpenFusionLauncher.exe - you will be given a choice between two public servers by default. Select the one you wish to play and click connect.
29+
4. To create an account, switch to the 'Register' tab and enter in your details, then click the Register button. If you have an account for the server already, you can enter it inside of the 'Log In' tab.
30+
5. Make a new character, and enjoy the game! Your progress will be saved automatically, and you can resume playing by entering the login details you used in step 4. Make sure to verify your email if you want to enable password recovery!
31+
32+
<!--
33+
## MacOS
2934
30-
Instructions for getting the client to run on Linux through Wine can be found [here](/docs/guides/running-on-linux/).
35+
## Linux
36+
-->
3137

3238
If you run into any issues, try checking [the FAQ](/docs/reference/frequently-asked-questions) or ask for assistance in our Discord server.
3339

content/docs/reference/_index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,9 @@
22
title: "Reference"
33
description: ""
44
summary: ""
5-
date: 2023-09-07T16:12:37+02:00
6-
lastmod: 2023-09-07T16:12:37+02:00
75
draft: false
86
weight: 900
97
toc: true
10-
sidebar:
11-
collapsed: true
128
seo:
139
title: "" # custom title (optional)
1410
description: "" # custom description (recommended)

content/docs/reference/frequently-asked-questions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Frequently Asked Questions"
33
description: ""
44
summary: ""
55
date: 2024-02-27T09:30:56+01:00
6-
lastmod: 2024-02-27T09:30:56+01:00
6+
lastmod: .Lastmod
77
draft: false
88
weight: 800
99
toc: true
@@ -16,10 +16,6 @@ seo:
1616

1717
## Logging in
1818

19-
### The Remember Me button isnt working, leaving me frozen in the login screen or simply not saving my login information. Is there a fix? {#remember-me}
20-
21-
The Remember Me button doesn't currently do anything. As a result, you need to remember your username and password correctly to login, as while we can recover usernames, we cannot recover passwords if you happen to forget it.
22-
2319
### Can I use the same login information on every OpenFusion or OF adjacent server? {#same-login}
2420

2521
No, you cannot. Our databases are separated between versions and the characters you create on one server cannot transfer onto another server. However, you are free to create those same characters (name included) on another server.
@@ -32,7 +28,7 @@ No, it will not. Our database is not shared with the original game or with Retro
3228

3329
### Is this a single player game? I can't seem to find anyone in-game. {#singleplayer-game}
3430

35-
No, if you're playing on our public servers (one of the two default entries in the launcher), the game isn't single player. It's just that there arent many players playing at a given time usually. You can usually find more people playing during the afternoon or on weekends, or if there is an event going on at the moment.
31+
No, if you're playing on our public servers (one of the two default entries in the launcher), the game isn't single player. It's just that there arent many players playing at a given time usually. You can usually find more people playing during the afternoon or on weekends, or if there is an event going on at the moment.
3632

3733
If you want the game to be single player, you can always set up a local server by following the instructions on https://github.com/OpenFusionProject/OpenFusion?tab=readme-ov-file#hosting-a-server
3834

@@ -70,7 +66,7 @@ In the Original game, you can give yourself items thru commands. To do this, typ
7066

7167
An an example: Using this command to give myself the Ben 10 Jacket would look something like this: `/itemN 1 38 1`, with 1 being the item type *(shirts)*, 38 being the item ID *(the ID of the Ben 10 Jacket)* and 1 being the quantity of item (keep this at one unless you are spawning gumballs or other stackable items).
7268

73-
If you wish to find all the item IDs in the game, refer to [this spreadsheet](https://docs.google.com/spreadsheets/d/1mpoJ9iTHl_xLI4wQ_9UvIDYNcsDYscdkyaGizs43TCg/edit#gid=0).
69+
If you wish to find all the item IDs in the game, refer to the [item IDs page](/docs/reference/item-id-list) or [this spreadsheet](https://docs.google.com/spreadsheets/d/1mpoJ9iTHl_xLI4wQ_9UvIDYNcsDYscdkyaGizs43TCg/edit#gid=0).
7470

7571
You cannot do this in the Academy server unless you make a private server for yourself.
7672

@@ -136,17 +132,21 @@ Unfortunately No. The game UI was never adapted to fit into higher resolutions s
136132

137133
### Help! I accidentally deleted the public server from my launcher! {#deleted-default-servers}
138134

139-
You can restore the default servers by clicking the version number in the lower right corner, then in the window that pops up, click "Reset to Default Servers".
135+
You can restore the default servers by clicking the green plus button, switching to the 'Endpoint Server' tab, then entering the following API hosts:
136+
137+
**OpenFusion Public - Original**: `api.dexlabs.systems`
138+
139+
**OpenFusion Public - Academy**: `api.dexlabs.systems/academy`
140140

141141
### I'm getting a LOGIN UNIMPLM or SHARD UNIMPLM error in the server log. How do I fix this? {#unimplm-packet}
142142

143-
* If it's a shard error and the number ends in 9889: You mixed up the login and shard ports.
143+
* If it's a shard error and the number ends in 9889: You mixed up the login and shard ports.
144144
When adding a new server to the client's list, *always use the login port* (default 23000).
145145

146-
* If it's a login error the number starts with 3187: You likely changed the login and shard to be the same port.
146+
* If it's a login error the number starts with 3187: You likely changed the login and shard to be the same port.
147147
Revert your config.ini to the default of 23000 for login, and 23001 for shard. (they need separate ports in order to work)
148148

149-
* Any other combination: Check that the version you selected in the client matches the server you're connecting to.
149+
* Any other combination: Check that the version you selected in the client matches the server you're connecting to.
150150
For an original server, select beta-20100104, and for an academy server select beta-20111013.
151151

152152
### Can I play the game on Android devices? Is it possible that a mobile port of the game will come out in the future? {#android-port}

0 commit comments

Comments
 (0)