Apple-2-Tools/izapple2
1
0
Fork 0
mirror of https://github.com/ivanizag/izapple2.git synced 2025-01-02 20:29:44 +00:00
Code Issues Projects Releases Wiki Activity

Fix markdown warnings

Browse Source
This commit is contained in:
Ivan Izaguirre 2020-08-08 13:40:48 +02:00
parent 6bfa1d2986
commit caabdf4781
1 changed files with 66 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -51,7 +51,6 @@ Portable emulator of an Apple II+ or //e. Written in Go.
- Pause (thanks a2geek)
- ProDOS MLI calls tracing
## Running the emulator
No installation required. [Download](https://github.com/ivanizag/apple2/releases) the single file executable `apple2xxx_xxx` for linux or Mac, SDL2 graphics or console. Build from source to get the latest features.
@ -59,32 +58,41 @@ No installation required. [Download](https://github.com/ivanizag/apple2/releases
### Default mode
Execute without parameters to have an emulated Apple //e Enhanced with 128kb booting DOS 3.3 ready to run Applesoft:
```
``` shell
casa@servidor:~$ ./apple2sdl
```
![DOS 3.3 started](doc/dos33.png)
### Play games
Download a DSK or WOZ file or use an URL ([Asimov](https://www.apple.asimov.net/images/) is an excellent source) with the `-disk` parameter:
```
``` shell
casa@servidor:~$ ./apple2sdl -disk "https://www.apple.asimov.net/images/games/action/karateka/karateka (includes intro).dsk"
```
![Karateka](doc/karateka.png)
### Play the Total Replay collection
Download the excellent [Total Replay](https://archive.org/details/TotalReplay) compilation by
[a2-4am](https://github.com/a2-4am/4cade). Run it with the `-hd` parameter:
```
``` shell
casa@servidor:~$ ./apple2sdl -hd "Total Replay v3.0.2mg"
```
Displays super hi-res box art as seen with the VidHD card.
![Total Replay](doc/totalreplay.png)
### Terminal mode
To run text mode right on the terminal without the SDL2 dependency, use `apple2console`. It runs on the console using ANSI escape codes. Input is sent to the emulated Apple II one line at a time:
```
``` shell
casa@servidor:~$ ./apple2console -model 2plus
############################################
@ -135,7 +143,7 @@ Only valid on SDL mode
### Command line options
```
``` shell
-charRom string
rom file for the character generator (default "<default>")
-disk string
@ -201,9 +209,10 @@ Only valid on SDL mode
The only dependency is having a working Go installation on any platform.
Run:
```
$ go get github.com/ivanizag/apple2/apple2console
$ go build github.com/ivanizag/apple2/apple2console
``` shell
go get github.com/ivanizag/apple2/apple2console
go build github.com/ivanizag/apple2/apple2console
```
### apple2sdl
@ -211,17 +220,19 @@ $ go build github.com/ivanizag/apple2/apple2console
Besides having a working Go installation, install the SDL2 developer files. Valid for any platform
Run:
```
$ go get github.com/ivanizag/apple2/apple2sdl
$ go build github.com/ivanizag/apple2/apple2sdl
``` shell
go get github.com/ivanizag/apple2/apple2sdl
go build github.com/ivanizag/apple2/apple2sdl
```
### Use docker to cross compile for Linux and Windows
To create executables for Linux and Windows without installing Go, SDL2 or the Windows cross compilation toosl, run:
```
$ cd docker
$ ./build.sh
``` shell
cd docker
./build.sh
```
To run in Windows, copy the file `SDL2.dll` on the same folder as `apple2sdl.exe`. The latest `SDL2.dll` can be found in the [Runtime binary for Windows 64-bit](https://www.libsdl.org/download-2.0.php).