Skip to content

Commit 2d62999

Browse files
committed
further improve readme formatting
1 parent 37c7556 commit 2d62999

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

readme.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
Wm3Util is a set of import scripts for the Unity Engine in order to load .wm3 files created by A3Tools.
77
A3Tools is a separate tool based on the Acknex8 engine, which converts Acknex3 raycaster levels to 3d meshes.
88
The .wm3 format was developed with Acknex8 use in mind, but it theoretically can be used in any engine.
9+
910
As Acknex8 does not feature a WYSIWYG development environment, it is very tedious to refine .wm3 levels.
1011
To overcome this, Wm3Util was developed, since Unity allows for more comfortable scene/level editing.
1112

@@ -15,6 +16,7 @@ To overcome this, Wm3Util was developed, since Unity allows for more comfortable
1516
A3Tools is a converter for raycaster sector/wall based levels (similar to 1993 Doom) created with the Acknex3 engine.
1617
This toolset is by far not completed, but still allows to convert many A3 levels (static only).
1718
A3Tools can export .wm3 files and .bmp textures, which allows for import into pretty much any 3d engine of choice.
19+
1820
The .wm3 format was developed having usage in Acknex8 in mind, though. Format is documented in A3Tools manual.
1921

2022
A3Tools utilizes the Acknex8 engine to operate, Windows binaries are included. The A3Tools project can be obtained from Github:
@@ -23,9 +25,10 @@ A3Tools utilizes the Acknex8 engine to operate, Windows binaries are included. T
2325

2426
## Why should I use Wm3Util?
2527

26-
Since you have come here, I expect you are aware of Acknex3, Acknex8 and Unity.
27-
Use this utility to pretty much whatever you want:
28+
Since you came here somehow, I expect you are aware of the existence of Acknex3, Acknex8 and Unity.
29+
So let's keep this short.
2830

31+
Use this utility to pretty much whatever you want:
2932
* Convert your old Acknex3 levels for fun
3033
* Use converted level as base for some retro project
3134
* Try to break the tool by importing awkward levels
@@ -35,6 +38,7 @@ Use this utility to pretty much whatever you want:
3538

3639
## How does it work?
3740

41+
Step-by-step guide:
3842
* Use A3Tools to convert a level of choice (refer to A3Tools documentation)
3943
* Fork Wm3Util project
4044
* Copy all generated files from A3Tools output directory to *Assets/Import* of your Wm3Util fork
@@ -43,10 +47,12 @@ Use this utility to pretty much whatever you want:
4347
* Open *Window -> Wm3 Importer*
4448

4549
The Wm3 Importer panel will show up. Configuration must be done for template materials and level.
50+
4651
![Wm3 Importer Panel](wm3panel.jpg)
4752

4853
Drag any .wm3.bytes file of choice to the Wm3 Importer dialog.
4954
The template materials can be found in *Assets/Wm3Util/Materials*. Drag them to the dialog as shown.
55+
5056
They are built in a way to imitate the Acknex3 look as close as possible. Customization is possible, though.
5157

5258

@@ -60,6 +66,7 @@ A sample project will be forked soon.
6066
This was a Unity learning project for me and is finished as such.
6167
Of course there are many improvements possible (like animated textures and player positioning),
6268
but usually they also require an A3Tools and .wm3 format update.
69+
6370
This quickly adds up to a lot of work for little use. Acknex3 was not used very commonly at its time.
6471
In case you are one of the very few former Acknex3 users and have a special request, feel free to contact me.
6572

@@ -74,5 +81,6 @@ Downwards compatibility was not tested.
7481

7582
Please respect [license.txt](license.txt) (Attribution-NonCommercial 4.0 International)
7683

77-
- firoball
84+
-firoball
85+
7886
[http://firoball.de](http://firoball.de)

0 commit comments

Comments
 (0)