squashed rp2040-doom changes

Author: kilograham

.github/CONTRIBUTING.md

@@ -7,7 +7,7 @@ aclocal.m4
 autom4te.cache
 autotools
 bin
-config.h
+/config.h
 config.hin
 config.log
 config.status
@@ -52,3 +52,8 @@ GPATH
 GRTAGS
 GTAGS
 /HTML/
+*.midx
+*.midx.z
+*.wad
+*.whd
+/cmake-*/

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,3 @@
+[submodule "3rdparty/tinyusb"]
+	path = 3rdparty/tinyusb
+	url = git@github.com:liamfraser/tinyusb.git

.gitignore

@@ -1,7 +1,30 @@
 set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
-cmake_minimum_required(VERSION 3.7.2)
-project("Chocolate Doom" VERSION 3.0.0 LANGUAGES C)
+cmake_minimum_required(VERSION 3.13)
+
+# We use PICO_SDK_PATH being set as an indicator that we're doing a Pico BUILD
+if (PICO_SDK_PATH)
+    include(pico_sdk_import.cmake)
+    include(pico_extras_import.cmake)
+endif()
+
+project("Chocolate Doom" VERSION 3.0.0 LANGUAGES C CXX)
+enable_language(CXX)
+set(CMAKE_CXX_STANDARD 14)
+
+if (PICO_SDK_PATH)
+    # we are using git@github.com:liamfraser/tinyusb.git as it has some RP2040 fixes that aren't upstreamed yet
+    set(PICO_TINYUSB_PATH ${CMAKE_CURRENT_LIST_DIR}/3rdparty/tinyusb)
+    # this only affects device builds device, but we want to use zone for malloc in this case so we don't have two separate elastic spaces and can fit more in
+    set(SKIP_PICO_MALLOC 1)
+    pico_sdk_init()
+    if (PICO_ON_DEVICE AND NOT CMAKE_BUILD_TYPE STREQUAL "MinSizeRel")
+        message(WARNING "You should do a MinSizeRel build when targeting the RP2040
+        (with -DCMAKE_BUILD_TYPE=MinSizeRel)")
+    endif()
+endif()
+
+set(CMAKE_C_STANDARD 11)
 
 # Autotools variables
 set(top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
@@ -24,26 +47,30 @@ if(MSVC)
     add_definitions("/D_CRT_SECURE_NO_WARNINGS" "/D_CRT_SECURE_NO_DEPRECATE"
                     "/D_CRT_NONSTDC_NO_DEPRECATE")
 else()
-    add_compile_options("-Wall" "-Wdeclaration-after-statement"
-                        "-Wredundant-decls")
-endif()
-
-find_package(SDL2 2.0.1)
-find_package(SDL2_mixer 2.0.0)
-find_package(SDL2_net 2.0.0)
-
-# Check for libsamplerate.
-find_package(samplerate)
-if(SAMPLERATE_FOUND)
-    set(HAVE_LIBSAMPLERATE TRUE)
+    #add_compile_options("-Wall" "-Wdeclaration-after-statement" "-Wredundant-decls")
+    add_compile_options("-Wall" "-Wredundant-decls")
 endif()
 
-# Check for libpng.
-find_package(PNG)
-if(PNG_FOUND)
-    set(HAVE_LIBPNG TRUE)
+# Note PICO_SDK path is set by the SDK initialization if it occurs above
+if (NOT PICO_SDK)
+    find_package(SDL2 2.0.1 REQUIRED)
+    find_package(SDL2_mixer 2.0.0 REQUIRED)
+    find_package(SDL2_net 2.0.0 REQUIRED)
+
+    # Check for libsamplerate.
+    find_package(samplerate)
+    if(SAMPLERATE_FOUND)
+        set(HAVE_LIBSAMPLERATE TRUE)
+    endif()
+
+    # Check for libpng.
+    find_package(PNG)
+    if(PNG_FOUND)
+        set(HAVE_LIBPNG TRUE)
+    endif()
 endif()
 
+set(HAVE_MMAP 1)
 find_package(m)
 
 include(CheckSymbolExists)

.gitmodules

@@ -0,0 +1,104 @@
+# Chocolate Doom
+
+Chocolate Doom aims to accurately reproduce the original DOS version of
+Doom and other games based on the Doom engine in a form that can be
+run on modern computers.
+
+Originally, Chocolate Doom was only a Doom source port. The project
+now includes ports of Heretic and Hexen, and Strife.
+
+Chocolate Doom’s aims are:
+
+ * To always be 100% Free and Open Source software.
+ * Portability to as many different operating systems as possible.
+ * Accurate reproduction of the original DOS versions of the games,
+   including bugs.
+ * Compatibility with the DOS demo, configuration and savegame files.
+ * To provide an accurate retro “feel” (display and input should
+   behave the same).
+
+More information about the philosophy and design behind Chocolate Doom
+can be found in the PHILOSOPHY file distributed with the source code.
+
+## Setting up gameplay
+
+For instructions on how to set up Chocolate Doom for play, see the
+INSTALL file.
+
+## Configuration File
+
+Chocolate Doom is compatible with the DOS Doom configuration file
+(normally named `default.cfg`). Existing configuration files for DOS
+Doom should therefore simply work out of the box. However, Chocolate
+Doom also provides some extra settings. These are stored in a
+separate file named `chocolate-doom.cfg`.
+
+The configuration can be edited using the chocolate-setup tool.
+
+## Command line options
+
+Chocolate Doom supports a number of command line parameters, including
+some extras that were not originally suported by the DOS versions. For
+binary distributions, see the CMDLINE file included with your
+download; more information is also available on the Chocolate Doom
+website.
+
+## Playing TCs
+
+With Vanilla Doom there is no way to include sprites in PWAD files.
+Chocolate Doom’s ‘-file’ command line option behaves exactly the same
+as Vanilla Doom, and trying to play TCs by adding the WAD files using
+‘-file’ will not work.
+
+Many Total Conversions (TCs) are distributed as a PWAD file which must
+be merged into the main IWAD. Typically a copy of DEUSF.EXE is
+included which performs this merge. Chocolate Doom includes a new
+option, ‘-merge’, which will simulate this merge. Essentially, the
+WAD directory is merged in memory, removing the need to modify the
+IWAD on disk.
+
+To play TCs using Chocolate Doom, run like this:
+
+```
+chocolate-doom -merge thetc.wad
+```
+
+Here are some examples:
+
+```
+chocolate-doom -merge batman.wad -deh batman.deh vbatman.deh  (Batman Doom)
+chocolate-doom -merge aoddoom1.wad -deh aoddoom1.deh  (Army of Darkness Doom)
+```
+
+## Other information
+
+ * Chocolate Doom includes a number of different options for music
+   playback. See the README.Music file for more details.
+
+ * More information, including information about how to play various
+   classic TCs, is available on the Chocolate Doom website:
+
+     https://www.chocolate-doom.org/
+
+   You are encouraged to sign up and contribute any useful information
+   you may have regarding the port!
+
+ * Chocolate Doom is not perfect. Although it aims to accurately
+   emulate and reproduce the DOS executables, some behavior can be very
+   difficult to reproduce. Because of the nature of the project, you
+   may also encounter Vanilla Doom bugs; these are intentionally
+   present; see the NOT-BUGS file for more information.
+
+   New bug reports can be submitted to the issue tracker on Github:
+
+     https://github.com/chocolate-doom/chocolate-doom/issues
+
+ * Source code patches are welcome, but please follow the style
+   guidelines - see the file named HACKING included with the source
+   distribution.
+
+ * Chocolate Doom is distributed under the GNU GPL. See the COPYING
+   file for more information.
+
+ * Please send any feedback, questions or suggestions to
+   chocolate-doom-dev-list@chocolate-doom.org. Thanks!