diff options
author | Franklin Wei <franklin@rockbox.org> | 2019-07-28 14:06:45 -0400 |
---|---|---|
committer | Franklin Wei <franklin@rockbox.org> | 2019-07-28 14:06:45 -0400 |
commit | 090bdedc62c7f35cbbe5cc5afb21836c3dc66101 (patch) | |
tree | b21028745676d6793e80c4c78bb918aa1aac497f | |
parent | 711ddfdaad18cee054213bcba4428ac3c6014774 (diff) | |
download | rockbox-090bdedc62c7f35cbbe5cc5afb21836c3dc66101.tar.gz rockbox-090bdedc62c7f35cbbe5cc5afb21836c3dc66101.zip |
quake: add README with some notes
Change-Id: I702e81f8715b505d4ed6d0eca861e3ddb680038d
-rw-r--r-- | apps/plugins/sdl/progs/quake/README.rockbox | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/apps/plugins/sdl/progs/quake/README.rockbox b/apps/plugins/sdl/progs/quake/README.rockbox new file mode 100644 index 0000000000..9e302f2898 --- /dev/null +++ b/apps/plugins/sdl/progs/quake/README.rockbox | |||
@@ -0,0 +1,42 @@ | |||
1 | Introduction | ||
2 | ============ | ||
3 | |||
4 | These are my port notes for Quake. This runs, of course, on our SDL | ||
5 | port. See <https://www.rockbox.org/wiki/SdlPort> for more. | ||
6 | |||
7 | Port Lineage | ||
8 | ============ | ||
9 | |||
10 | This port stems from SDLQuake | ||
11 | (https://www.libsdl.org/projects/quake/), which was built on top of id | ||
12 | Software's source release. | ||
13 | |||
14 | How is <X> done? | ||
15 | ================ | ||
16 | |||
17 | Custom settings: This is implemented through a modification to | ||
18 | Cmd_Exec_f and Key_Bind_f, in cmd.c and keys.c. | ||
19 | |||
20 | Sound mixing: There is a handwritten assembly sound mixing routine in | ||
21 | snd_mix_arm.S, using the ARMv5 DSP extensions for saturating | ||
22 | addition. Disable that if you run into sound issues. | ||
23 | |||
24 | File caching: There is an automatic caching layer in sys_sdl.c which | ||
25 | loads files over 1 MB into memory. Quake only uses about 8 MB of heap | ||
26 | when running, so there's plenty of space for this on some targets | ||
27 | (e.g. ipods). | ||
28 | |||
29 | Known bugs | ||
30 | ========== | ||
31 | |||
32 | Setting the sample rate to 44.1 KHz leads to all sorts of weird | ||
33 | crashes, which stem (probably) from the same underlying memory | ||
34 | corruption issue. Only thing is, it seems to occur only on hardware so | ||
35 | it's a huge pain to debug. | ||
36 | |||
37 | Optimization targets | ||
38 | ==================== | ||
39 | |||
40 | D_DrawZSpans, D_DrawSpans8, and Turbulent8 (in d_scan.c) should be | ||
41 | fairly straightforward to write in assembly and are big time | ||
42 | hogs. Make them fast! | ||