EDuke32

https://wiki.eduke32.com
Admin
EDuke32 is a cross-platform source port of Duke Nukem 3D that enhances the Build engine with modern...
Tokens:536,180
Snippets:4,010
Trust Score:9.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### artfile DEF command examples

Source: https://wiki.eduke32.com/wiki/Artfile_%28DEF%29

Two examples of the artfile DEF command. The first loads an ART file with its default starting tile number. The second overrides the starting tile number with the tile sub-token, useful when the ART file's internal tilestart is not desired.

```text
artfile { file "whatever.art" } // loads whatever.art just as if it had been named TILES020.ART
```

```text
artfile { file "whatever.art" tile 2000 } // loads whatever.art starting at index 2000 instead of the tilestart value contained within it
```

--------------------------------

### Install build toolchain packages

Source: https://wiki.eduke32.com/wiki/Building_EDuke32_on_Windows

Install the necessary toolchains for building EDuke32.

```bash
pacman -S --needed --noconfirm mingw-w64-{i686,x86_64,ucrt-x86_64,clang-x86_64}-toolchain make nasm yasm
```

--------------------------------

### DMFLAGS GameVar Examples

Source: https://wiki.eduke32.com/wiki/NetDuke32

Examples for checking and setting DMFlags.

```text
ifvarand DMFLAGS 4 { spawn LIZTROOP }
orvar DMFLAGS 256
```

--------------------------------

### Install version control packages

Source: https://wiki.eduke32.com/wiki/Building_EDuke32_on_Windows

Install Subversion and Git for use within the MSYS2 shell.

```bash
pacman -S --needed --noconfirm subversion git
```

--------------------------------

### Install Clang compiler packages

Source: https://wiki.eduke32.com/wiki/Building_EDuke32_on_Windows

Install Clang and LLD as additional compiler options.

```bash
pacman -S --needed --noconfirm mingw-w64-{x86_64,ucrt-x86_64,clang-x86_64}-{clang,lld}
```

--------------------------------

### Install EDuke32 via CLI

Source: https://wiki.eduke32.com/wiki/APT_repository

Update your package list and install the eduke32 package.

```bash
sudo apt-get update
sudo apt-get install eduke32
```

--------------------------------

### Define EVENT_NEWGAMECUSTOM logic

Source: https://wiki.eduke32.com/wiki/EVENT_NEWGAMECUSTOM

This example demonstrates how to handle menu selections by checking userdef.return values to set the appropriate volume and level numbers for the game.

```EDuke32 Script
appendevent EVENT_NEWGAMECUSTOM
   ife userdef.return 1 -1 // Case: no submenu
   {
       switch userdef.return 0
       case 1 setu[].m_volume_number 1 break // Lunar Apocalypse
       case 2 setu[].m_volume_number 2 break // Shrapnel City
       case 3 setu[].m_volume_number 3 break // The Birth
       default setu[].m_volume_number 0 break
       endswitch
       setu[].m_level_number 0 
   }
   else ife userdef.return 0 0 // Case: submenu at position 0 (L.A. Meltdown)
   {
       setu[].m_volume_number 0
       switch userdef.return 1
       case 0 setu[].m_level_number 0 break // Hollywood Holocaust
       case 1 setu[].m_level_number 1 break // Red Light District
       case 2 setu[].m_level_number 2 break // Death Row
       case 3 setu[].m_level_number 3 break // Toxic Dump
       case 4 setu[].m_level_number 4 break // The Abyss
       default setu[].m_level_number 0 break
       endswitch
   }
endevent
```

--------------------------------

### Define BIGALPHANUM character mapping

Source: https://wiki.eduke32.com/wiki/Tilefont_%28DEF%29

This example configures the BIGALPHANUM tilenum (2940) to display characters using the tilenums starting from 2822.

```DEF
tilefont 2940
{
  chr "!" 2822
  // chr """ 2823
  chr "#" 2824
  chr "$" 2825
  chr "%" 2826
  chr "&" 2827
  chr "'" 2828
  chr "(" 2829
  chr ")" 2830
  chr "*" 2831
  chr "+" 2832
  chr "," 2833
  chr "-" 2834
  chr "." 2835
  chr "/" 2836
  chr "0" 2837
  chr "1" 2838
  chr "2" 2839
  chr "3" 2840
  chr "4" 2841
  chr "5" 2842
  chr "6" 2843
  chr "7" 2844
  chr "8" 2845
  chr "9" 2846
  chr ":" 2847
  chr ";" 2848
  chr "<" 2849
  chr "=" 2850
  chr ">" 2851
  chr "?" 2852
  chr "@" 2853
  chr "A" 2854
  chr "B" 2855
  chr "C" 2856
  chr "D" 2857
  chr "E" 2858
  chr "F" 2859
  chr "G" 2860
  chr "H" 2861
  chr "I" 2862
  chr "J" 2863
  chr "K" 2864
  chr "L" 2865
  chr "M" 2866
  chr "N" 2867
  chr "O" 2868
  chr "P" 2869
  chr "Q" 2870
  chr "R" 2871
  chr "S" 2872
  chr "T" 2873
  chr "U" 2874
  chr "V" 2875
  chr "W" 2876
  chr "X" 2877
  chr "Y" 2878
  chr "Z" 2879
  chr "[" 2880
  // chr "\" 2881
  chr "]" 2882
  chr "^" 2883
  chr "_" 2884
  chr "`" 2885
  chr "a" 2886
  chr "b" 2887
  chr "c" 2888
  chr "d" 2889
  chr "e" 2890
  chr "f" 2891
  chr "g" 2892
  chr "h" 2893
  chr "i" 2894
  chr "j" 2895
  chr "k" 2896
  chr "l" 2897
  chr "m" 2898
  chr "n" 2899
  chr "o" 2900
  chr "p" 2901
  chr "q" 2902
  chr "r" 2903
  chr "s" 2904
  chr "t" 2905
  chr "u" 2906
  chr "v" 2907
  chr "w" 2908
  chr "x" 2909
  chr "y" 2910
  chr "z" 2911
  chr "{" 2912
  chr "|" 2913
  chr "}" 2914
  chr "~" 2915
}
```

--------------------------------

### Console Output for Event Chaining Example

Source: https://wiki.eduke32.com/wiki/Event

The resulting console output when starting a level, showing the execution order of the defined events.

```text
-2
-1
0
1
2
```

--------------------------------

### Get floor Z coordinate with getflorzofslope

Source: https://wiki.eduke32.com/wiki/Getflorzofslope

Example usage of getflorzofslope in conjunction with updatesectorz to determine the floor height at an actor's current position.

```EDuke32
getactor[THISACTOR].x x
getactor[THISACTOR].y y
getactor[THISACTOR].z z
updatesectorz x y z temp
getflorzofslope temp x y temp2
```

--------------------------------

### Load a shade table with 32 steps

Source: https://wiki.eduke32.com/wiki/Palookup_%28DEF%29

This example demonstrates the basic syntax for loading a shade table using the palookup command.

```DEF
palookup 0 { raw { file "shade.raw" } }
```

--------------------------------

### EVENT_VALIDATESTART implementation for Ion Fury

Source: https://wiki.eduke32.com/wiki/EVENT_VALIDATESTART

This example demonstrates how to adjust the level number for invalidated save loads in Ion Fury to ensure the player starts at the correct map.

```CON
// Code by Jonathan Strander, Fox Martins, Richard Gobeille, and Evan Ramos
// All code as written belongs to Voidpoint and the respective authors.
// (c) 2019 Voidpoint, LLC
appendevent EVENT_VALIDATESTART
   ife userdef .return 0 EP_PREVIEW
   {
       switch userdef .return 1
           case 1
               setu .return 1 0
               break
           case 3
           case 4
               setu .return 1 2
               break
       endswitch
   }
endevent
```

--------------------------------

### setuptile command syntax

Source: https://wiki.eduke32.com/wiki/Setuptile_%28DEF%29

Defines properties for a single highres replacement tile.

```text
setuptile <tilenum> <width> <height> <x-offset> <y-offset>
```

--------------------------------

### Three-Player Hosted Game Launch

Source: https://wiki.eduke32.com/wiki/Command_line_options

Example commands for hosting and joining a three-player game session.

```bash
voidsw -net -n0:3
voidsw -net -n0 host1
voidsw -net -n0 host1
```

--------------------------------

### gametext usage example with variable setup

Source: https://wiki.eduke32.com/wiki/Gametextz

Example of using gametext to print a quote. It sets variables for position, shade, palette, tile number, orientation, and a quote, then calls gametext. The comment notes that x=320 centers text and that the quote uses ^10 to tint 'red' red. This command only works during events.

```eduke32
setvar x 320                                // "x=320" centers text
setvar y 100
setvar shade 0
setvar pal 0
setvar tilenum STARTALPHANUM
setvar orientation 26
setvar TEMP 100
redefinequote TEMP This is ^10red           // tints the word "red", 10 is red.

gametext tilenum x y TEMP shade pal orientation ZERO ZERO xdim ydim
```
Tokens:
Raw