Skip to content

Commit d43eab5

Browse files
Fixed URL links in the manual
1 parent c08a6de commit d43eab5

File tree

5 files changed

+19
-20
lines changed

5 files changed

+19
-20
lines changed

documentation/manual/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ all:
22
sed 's/^# /\\newpage\n# /g' manual.md > manual2.md
33
sed 's/^# /\\newpage\n# /g' techreport.md > techreport2.md
44
#pandoc --metadata-file=custom.yaml --toc --top-level-division=part -V documentclass=report --from=markdown+multiline_tables -H custom.tex manual2.md -o manual.pdf
5-
pandoc --metadata-file=custom.yaml --toc -V documentclass=report --from=markdown+multiline_tables -H custom.tex manual2.md -o manual.pdf
6-
pandoc --metadata-file=custom.yaml --toc -V documentclass=report --from=markdown+multiline_tables -H custom.tex techreport2.md -o techreport.pdf
5+
pandoc --metadata-file=custom.yaml --toc -V documentclass=report --from=markdown+multiline_tables -V colorlinks=true -V linkcolor=red -V urlcolor=blue -H custom.tex manual2.md -o manual.pdf
6+
pandoc --metadata-file=custom.yaml --toc -V documentclass=report -V colorlinks=true -V linkcolor=red -V urlcolor=blue --from=markdown+multiline_tables -H custom.tex techreport2.md -o techreport.pdf
77
pandoc --metadata-file=custom-player.yaml --from=markdown+multiline_tables -H custom.tex player_manual.md -o player_manual.pdf
88
rm manual2.md
99
rm techreport2.md

documentation/manual/manual.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Ozmoo should be able to run most Z-code games, regardless of size (A Z-code game
3535

3636
# Quickstart
3737

38-
The simplest option is to use Ozmoo Online, a web page where you can build games with Ozmoo without installing anything on your computer. It supports most of the options Ozmoo has. Ozmoo online is located at: http://ozmoo.online
38+
The simplest option is to use Ozmoo Online, a web page where you can build games with Ozmoo without installing anything on your computer. It supports most of the options Ozmoo has. Ozmoo online is located at: [http://ozmoo.online](http://ozmoo.online)
3939

4040
The other option is to install Ozmoo on your computer. This can be done on Windows, Linux and Mac OS X. To build a game, you run something like "ruby make.rb game.z5" Add -s to make the game start in Vice when it has been built.
4141

@@ -53,19 +53,19 @@ You need to install:
5353

5454
#### Windows
5555

56-
Acme can be downloaded from SourceForge: https://sourceforge.net/projects/acme-crossass/
56+
Acme can be downloaded from SourceForge: [https://sourceforge.net/projects/acme-crossass/](https://sourceforge.net/projects/acme-crossass/)
5757

58-
Exomizer can be downloaded from Bitbucket. The download includes binaries for Windows: https://bitbucket.org/magli143/exomizer/wiki/browse/downloads
58+
Exomizer can be downloaded from Bitbucket. The download includes binaries for Windows: [https://bitbucket.org/magli143/exomizer/wiki/browse/downloads](https://bitbucket.org/magli143/exomizer/wiki/browse/downloads)
5959

60-
Get WinVice from SourceForge: http://vice-emu.sourceforge.net/windows.html
60+
Get WinVice from SourceForge: [http://vice-emu.sourceforge.net/windows.html](http://vice-emu.sourceforge.net/windows.html)
6161

62-
You can get Ruby from RubyInstaller: https://rubyinstaller.org/
62+
You can get Ruby from RubyInstaller: [https://rubyinstaller.org/](https://rubyinstaller.org/)
6363

64-
Download the MEGA65 emulator from https://github.lgb.hu/xemu/, and read the instructions on setting it up at https://github-wiki-see.page/m/lgblgblgb/xemu/wiki/MEGA65-quickstart
64+
Download the MEGA65 emulator from [https://github.lgb.hu/xemu/](https://github.lgb.hu/xemu/), and read the instructions on setting it up at [https://github-wiki-see.page/m/lgblgblgb/xemu/wiki/MEGA65-quickstart](https://github-wiki-see.page/m/lgblgblgb/xemu/wiki/MEGA65-quickstart)
6565

66-
Get 7-Zip from https://www.7-zip.org/
66+
Get 7-Zip from [https://www.7-zip.org/](https://www.7-zip.org/)
6767

68-
The Commander X16 emulator is available at https://github.com/X16Community/x16-emulator
68+
The Commander X16 emulator is available at [https://github.com/X16Community/x16-emulator](https://github.com/X16Community/x16-emulator)
6969

7070
#### Linux
7171

@@ -88,11 +88,11 @@ Ruby is available on Debian/Ubuntu with:
8888

8989
> sudo apt install ruby
9090

91-
Download the MEGA65 emulator from https://github.lgb.hu/xemu/, and read the instructions on setting it up at https://github-wiki-see.page/m/lgblgblgb/xemu/wiki/MEGA65-quickstart
91+
Download the MEGA65 emulator from [https://github.lgb.hu/xemu/](https://github.lgb.hu/xemu/), and read the instructions on setting it up at [https://github-wiki-see.page/m/lgblgblgb/xemu/wiki/MEGA65-quickstart](https://github-wiki-see.page/m/lgblgblgb/xemu/wiki/MEGA65-quickstart)
9292

9393
The zip program that ships with Linux is all you need for zipping Ozmoo games for X16.
9494

95-
The Commander X16 emulator is available at https://github.com/X16Community/x16-emulator
95+
The Commander X16 emulator is available at [https://github.com/X16Community/x16-emulator](https://github.com/X16Community/x16-emulator)
9696

9797
## Customizing the make script
9898

@@ -192,7 +192,7 @@ The Commander X16 version is using the extended RAM fully to preload the story f
192192

193193
## Other targets
194194

195-
A fork of Ozmoo targeting the Acorn computers (BBC Micro and other variants) can be found at https://github.com/ZornsLemma/ozmoo/tree/acorn. Note that this fork is using a different build script called make-acorn.py.
195+
A fork of Ozmoo targeting the Acorn computers (BBC Micro and other variants) can be found at [https://github.com/ZornsLemma/ozmoo/tree/acorn](https://github.com/ZornsLemma/ozmoo/tree/acorn). Note that this fork is using a different build script called make-acorn.py.
196196

197197
# Build Modes
198198

@@ -484,11 +484,11 @@ Since sound effect 1 and 2 are reserved for beeps, the sample based sound effect
484484

485485
## Legacy support for Sherlock and The Lurking Horror
486486

487-
Ozmoo includes support for Sherlock and The Lurking Horror from Infocom, with sound effects. While they can't be built with sound support on Ozmoo Online, there is a link there to download them for the MEGA65. Go to https://microheaven.com/ozmooonline/ and search for "sherlock" on the page.
487+
Ozmoo includes support for Sherlock and The Lurking Horror from Infocom, with sound effects. While they can't be built with sound support on Ozmoo Online, there is a link there to download them for the MEGA65. Go to [https://microheaven.com/ozmooonline/](https://microheaven.com/ozmooonline/) and search for "sherlock" on the page.
488488

489-
If you have Ozmoo installed on your own computer, you can download a Blorb archive of AIFF versions of the sound files from: https://ifarchive.org/indexes/if-archive/infocom/media/blorb/
489+
If you have Ozmoo installed on your own computer, you can download a Blorb archive of AIFF versions of the sound files from: [https://ifarchive.org/indexes/if-archive/infocom/media/blorb/](https://ifarchive.org/indexes/if-archive/infocom/media/blorb/)
490490

491-
The individual sound files must be extracted from the archive. For blorb files there are various tools, such as rezrov, available: https://ifarchive.org/indexes/if-archiveXprogrammingXblorb.html
491+
The individual sound files must be extracted from the archive. For blorb files there are various tools, such as rezrov, available: [https://ifarchive.org/indexes/if-archiveXprogrammingXblorb.html](https://ifarchive.org/indexes/if-archiveXprogrammingXblorb.html)
492492

493493
The AIFF files should be moved to a folder that is later included with the -asa switch when using the make.rb script to build the game. Make sure that the filenames follow the pattern described above (starting with 003.aiff).
494494

documentation/manual/techreport.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -447,15 +447,14 @@ where
447447

448448
If you want to create a character mapping for say Czech, and you know you will never want to build a game in Swedish, you can just replace the Swedish mapping in streams.asm and use -cm:sv to refer to your Czech mapping.
449449

450-
The definition of ZSCII can be found at
451-
452-
https://www.inform-fiction.org/zmachine/standards/z1point1/sect03.html#eight
450+
The definition of ZSCII can be found at: [https://www.inform-fiction.org/zmachine/standards/z1point1/sect03.html#eight](https://www.inform-fiction.org/zmachine/standards/z1point1/sect03.html#eight)
453451

454452
The accented characters which are available by default, and which Ozmoo can
455453
use, are in a table under 3.8.7.
456454

457455
The definition of PETSCII can be found at:
458-
http://sta.c64.org/cbm64petkey.html
456+
[http://sta.c64.org/cbm64petkey.html](http://sta.c64.org/cbm64petkey.html)
457+
459458
Please read the notes below the table as well.
460459

461460
Note that in the mapping from PETSCII to ZSCII, you must also convert any accented characters from uppercase to lowercase, i.e. for Swedish PETSCII Ä is mapped to a ZSCII ä.

documentation/ozmoo_14.pdf

1.56 KB
Binary file not shown.

documentation/techreport_14.pdf

365 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)