slifer 0.1.2 → 0.1.3

package/README.md

@@ -6,15 +6,18 @@
 
 > [!CAUTION]
 > Slifer is currently in alpha. Use at your own risk.
->
 
-> [!NOTE]
-> Not all basic features have been implemented. Many are missing such as window customization.
-> As such, I recommend waiting for a beta release of Slifer before using it for a long term project.
+> [!NOTE] 
+> Not all basic features have been implemented. Many are missing such as
+> window customization. As such, I recommend waiting for a beta release of
+> Slifer before using it for a long term project.
 
-Slifer is a game framework made to allow users to code games in typescript. The framework uses bun and SDL2 under the hood to allow your game to render and build natively to desktop.
+Slifer is a game framework made to allow users to code games in typescript. The
+framework uses bun and SDL2 under the hood to allow your game to render and
+build natively to desktop.
 
 ## Contents
+
 - [Goals](#goals)
 - [Current Features](#current-features)
 - [Future Features](#future-features)
@@ -22,38 +25,42 @@ Slifer is a game framework made to allow users to code games in typescript. The
 
 ## Goals
 
-- Contain all basic game framework implementations. Such as drawing images, drawing text and making animations from a sprite sheet.
+- Contain all basic game framework implementations. Such as drawing images,
+  drawing text and making animations from a sprite sheet.
 - Provide an easy transition from web development to game development.
 - Create an easy to use framework. Slifer should handle the bulk of the work
 - Keep updates consistent.
 
 ## Current Features
+
 - Create a native desktop window with custom title and size.
 - Handle both keyboard and mouse inputs
 - Load and draw images onto the window
 
 ## Future Features
+
 - Audio Implementation
 - Animation library
 - Save file library
 
 ## Example
+
 ```ts
-import Slifer from Slifer;
+import Slifer from "slifer";
 
 Slifer.createWindow("Example Window", 640, 480);
 
 const bg = Slifer.Graphics.makeColor(36, 36, 36, 255);
 
 while (!Slifer.shouldClose()) {
-    Slifer.Graphics.setBackground(bg);
+  Slifer.Graphics.setBackground(bg);
 
-    if (Slifer.Keyboard.isPressed('escape')) {
-        Slifer.isRunning = false;
-    }
+  if (Slifer.Keyboard.isPressed("escape")) {
+    Slifer.isRunning = false;
+  }
 
-    Slifer.Graphics.render();
+  Slifer.Graphics.render();
 }
 
 Slifer.quit();
-```
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slifer",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A game framework made for bun and typescript",
   "module": "index.ts",
   "devDependencies": {

package/src/ffi.ts

@@ -1,4 +1,4 @@
-import { dlopen, FFIType, suffix } from 'bun:ffi';
+import { dlopen, FFIType, suffix } from "bun:ffi";
 
 let libSDLImport;
 let libImageImport;
@@ -6,208 +6,222 @@ let libTTFImport;
 let libGFXImport;
 
 if (process.platform == "win32") {
-    //@ts-expect-error
-    libSDLImport = await import("../libs/libSDL2.dll");
-    //@ts-expect-error
-    libImageImport = await import("../libs/libSDL2_image.dll");
-    //@ts-expect-error
-    libTTFImport = await import("../libs/libSDL2_ttf.dll");
+  //@ts-expect-error
+  libSDLImport = await import("../libs/libSDL2.dll");
+  //@ts-expect-error
+  libImageImport = await import("../libs/libSDL2_image.dll");
+  //@ts-expect-error
+  libTTFImport = await import("../libs/libSDL2_ttf.dll");
 } else if (process.platform == "darwin") {
-    //@ts-expect-error
-    libSDLImport = await import("../libs/libSDL2.dylib");
-    //@ts-expect-error
-    libImageImport = await import("../libs/libSDL2_image.dylib");
-    //@ts-expect-error
-    libTTFImport = await import("../libs/libSDL2_ttf.dylib");
+  //@ts-expect-error
+  libSDLImport = await import("../libs/libSDL2.dylib");
+  //@ts-expect-error
+  libImageImport = await import("../libs/libSDL2_image.dylib");
+  //@ts-expect-error
+  libTTFImport = await import("../libs/libSDL2_ttf.dylib");
+} else if (process.platform == "linux") {
+  //@ts-expect-error
+  libSDLImport = await import("../libs/libSDL2.so");
+  //@ts-expect-error
+  libImageImport = await import("../libs/libSDL2_image.so");
+  //@ts-expect-error
+  libTTFImport = await import("../libs/libSDL2_ttf.so");
 }
 
 export const libsdl = dlopen(libSDLImport.default, {
-    SDL_Init: {
-        args: [FFIType.int],
-        returns: FFIType.int
-    },
-    SDL_GetRevision: {
-        returns: 'cstring'
-    },
-    SDL_CreateWindow: {
-        args: ['cstring', 'int', 'int', 'int', 'int', 'u32'],
-        returns: 'pointer'
-    },
-    SDL_CreateRenderer: {
-        args: ['pointer', 'int', 'u32'],
-        returns: 'pointer'
-    },
-    SDL_GetDesktopDisplayMode: {
-        args: ['int', 'pointer'],
-        returns: 'int'
-    },
-    SDL_GetDisplayOrientation: {
-        args: ['int'],
-        returns: 'int'
-    },
-    SDL_SetWindowFullscreen: {
-        args: ['pointer', 'u32'],
-        returns: 'int'
-    },
-    SDL_PollEvent: {
-        args: ['pointer'],
-        returns: 'int'
-    },
-    SDL_RenderClear: {
-        args: ['pointer'],
-        returns: 'int'
-    },
-    SDL_RenderCopy: {
-        args: ['pointer', 'pointer', 'pointer', 'pointer'],
-        returns: 'int'
-    },
-    SDL_RenderPresent: {
-        args: ['pointer'],
-        returns: 'void'
-    },
-    SDL_CreateTextureFromSurface: {
-        args: ['pointer', 'pointer'],
-        returns: 'pointer'
-    },
-    SDL_DestroyRenderer: {
-        args: ['pointer'],
-        returns: 'void'
-    },
-    SDL_DestroyWindow: {
-        args: ['pointer'],
-        returns: 'void'
-    },
-    SDL_Quit: {
-        returns: 'void'
-    },
-    SDL_GetKeyName: {
-        args: ['int'],
-        returns: 'cstring'
-    },
-    SDL_GetKeyFromScancode: {
-        args: ['int'],
-        returns: 'int'
-    },
-    SDL_GetPerformanceCounter: {
-        returns: 'u64'
-    },
-    SDL_GetPerformanceFrequency: {
-        returns: 'u64'
-    },
-    SDL_QueryTexture :{
-        args: ['pointer', 'pointer', 'pointer', 'pointer', 'pointer'],
-        returns: 'int'
-    },
-    SDL_GetMouseState: {
-        args: ['pointer', 'pointer'],
-        returns: 'u32'
-    },
-    SDL_CreateColorCursor: {
-        args: ['pointer', 'int', 'int'],
-        returns: 'pointer'
-    },
-    SDL_SetCursor: {
-        args: ['pointer'],
-        returns: 'void'
-    },
-    SDL_SetRenderDrawColor: {
-        args: ['pointer', 'int', 'int', 'int', 'int'],
-        returns: 'void'
-    },
-    SDL_RenderFillRect: {
-        args: ['pointer', 'pointer'],
-        returns: 'bool'
-    },
-    SDL_GetWindowPosition: {
-        args: ['pointer', 'pointer', 'pointer'],
-        returns: 'void'
-    },
-    SDL_SetWindowPosition: {
-        args: ['pointer', 'int', 'int'],
-        returns: 'void'
-    },
-    SDL_SetWindowHitTest: {
-        args: ['pointer', FFIType.function, 'pointer'],
-        returns: 'int'
-    },
-    SDL_GetWindowSize: {
-        args: ['pointer', 'pointer', 'pointer'],
-        returns: 'void'
-    },
-    SDL_CreateSystemCursor: {
-        args:['int'],
-        returns: 'pointer'
-    },
-    SDL_GetError: {
-        returns: 'cstring'
-    },
-    SDL_SetHint: {
-        args: ['cstring', 'cstring'],
-        returns: 'bool'
-    },
-    SDL_MinimizeWindow: {
-        args: ['pointer'],
-        returns: 'void'
-    },
-    SDL_GetShapedWindowMode: {
-        args: ['pointer', 'pointer'],
-        returns: 'int'
-    },
-    SDL_CreateShapedWindow: {
-        args: ['cstring', 'int', 'int', 'int', 'int', 'u32'],
-        returns: 'pointer'
-    },
-    SDL_SetWindowShape: {
-        args: ['pointer', 'pointer', 'pointer'],
-        returns: 'int'
-    },
-    SDL_SetWindowIcon: {
-        args: ['pointer', 'pointer'],
-        returns: 'void'
-    },
-    SDL_RaiseWindow: {
-        args: ['pointer'],
-        returns: 'void'
-    },
-    SDL_RenderCopyEx: {
-        args: ['pointer', 'pointer', 'pointer', 'pointer', 'double', 'pointer', 'int'],
-        returns: 'int'
-    }
-})
+  SDL_Init: {
+    args: [FFIType.int],
+    returns: FFIType.int,
+  },
+  SDL_GetRevision: {
+    returns: "cstring",
+  },
+  SDL_CreateWindow: {
+    args: ["cstring", "int", "int", "int", "int", "u32"],
+    returns: "pointer",
+  },
+  SDL_CreateRenderer: {
+    args: ["pointer", "int", "u32"],
+    returns: "pointer",
+  },
+  SDL_GetDesktopDisplayMode: {
+    args: ["int", "pointer"],
+    returns: "int",
+  },
+  SDL_GetDisplayOrientation: {
+    args: ["int"],
+    returns: "int",
+  },
+  SDL_SetWindowFullscreen: {
+    args: ["pointer", "u32"],
+    returns: "int",
+  },
+  SDL_PollEvent: {
+    args: ["pointer"],
+    returns: "int",
+  },
+  SDL_RenderClear: {
+    args: ["pointer"],
+    returns: "int",
+  },
+  SDL_RenderCopy: {
+    args: ["pointer", "pointer", "pointer", "pointer"],
+    returns: "int",
+  },
+  SDL_RenderPresent: {
+    args: ["pointer"],
+    returns: "void",
+  },
+  SDL_CreateTextureFromSurface: {
+    args: ["pointer", "pointer"],
+    returns: "pointer",
+  },
+  SDL_DestroyRenderer: {
+    args: ["pointer"],
+    returns: "void",
+  },
+  SDL_DestroyWindow: {
+    args: ["pointer"],
+    returns: "void",
+  },
+  SDL_Quit: {
+    returns: "void",
+  },
+  SDL_GetKeyName: {
+    args: ["int"],
+    returns: "cstring",
+  },
+  SDL_GetKeyFromScancode: {
+    args: ["int"],
+    returns: "int",
+  },
+  SDL_GetPerformanceCounter: {
+    returns: "u64",
+  },
+  SDL_GetPerformanceFrequency: {
+    returns: "u64",
+  },
+  SDL_QueryTexture: {
+    args: ["pointer", "pointer", "pointer", "pointer", "pointer"],
+    returns: "int",
+  },
+  SDL_GetMouseState: {
+    args: ["pointer", "pointer"],
+    returns: "u32",
+  },
+  SDL_CreateColorCursor: {
+    args: ["pointer", "int", "int"],
+    returns: "pointer",
+  },
+  SDL_SetCursor: {
+    args: ["pointer"],
+    returns: "void",
+  },
+  SDL_SetRenderDrawColor: {
+    args: ["pointer", "int", "int", "int", "int"],
+    returns: "void",
+  },
+  SDL_RenderFillRect: {
+    args: ["pointer", "pointer"],
+    returns: "bool",
+  },
+  SDL_GetWindowPosition: {
+    args: ["pointer", "pointer", "pointer"],
+    returns: "void",
+  },
+  SDL_SetWindowPosition: {
+    args: ["pointer", "int", "int"],
+    returns: "void",
+  },
+  SDL_SetWindowHitTest: {
+    args: ["pointer", FFIType.function, "pointer"],
+    returns: "int",
+  },
+  SDL_GetWindowSize: {
+    args: ["pointer", "pointer", "pointer"],
+    returns: "void",
+  },
+  SDL_CreateSystemCursor: {
+    args: ["int"],
+    returns: "pointer",
+  },
+  SDL_GetError: {
+    returns: "cstring",
+  },
+  SDL_SetHint: {
+    args: ["cstring", "cstring"],
+    returns: "bool",
+  },
+  SDL_MinimizeWindow: {
+    args: ["pointer"],
+    returns: "void",
+  },
+  SDL_GetShapedWindowMode: {
+    args: ["pointer", "pointer"],
+    returns: "int",
+  },
+  SDL_CreateShapedWindow: {
+    args: ["cstring", "int", "int", "int", "int", "u32"],
+    returns: "pointer",
+  },
+  SDL_SetWindowShape: {
+    args: ["pointer", "pointer", "pointer"],
+    returns: "int",
+  },
+  SDL_SetWindowIcon: {
+    args: ["pointer", "pointer"],
+    returns: "void",
+  },
+  SDL_RaiseWindow: {
+    args: ["pointer"],
+    returns: "void",
+  },
+  SDL_RenderCopyEx: {
+    args: [
+      "pointer",
+      "pointer",
+      "pointer",
+      "pointer",
+      "double",
+      "pointer",
+      "int",
+    ],
+    returns: "int",
+  },
+});
 
 export const libimage = dlopen(libImageImport.default, {
-    IMG_Init: {
-        args: ['int'],
-        returns: 'int'
-    },
-    IMG_Load: {
-        args: ['cstring'],
-        returns: 'pointer'
-    }
-})
+  IMG_Init: {
+    args: ["int"],
+    returns: "int",
+  },
+  IMG_Load: {
+    args: ["cstring"],
+    returns: "pointer",
+  },
+});
 
 export const libttf = dlopen(libTTFImport.default, {
-    TTF_Init: {
-        returns: 'int'
-    },
-    TTF_OpenFont: {
-        args: ['cstring', 'int'],
-        returns: 'pointer'
-    },
-    TTF_RenderText_Solid: {
-        args: ['pointer', 'cstring', 'u32'],
-        returns: 'pointer'
-    },
-    TTF_SizeText: {
-        args: ['pointer', 'cstring', 'pointer', 'pointer'],
-        returns: 'int'
-    },
-    TTF_Quit: {
-        returns: 'void'
-    },
-    TTF_CloseFont: {
-        args: ['pointer'],
-        returns: 'void'
-    }
-
-})
+  TTF_Init: {
+    returns: "int",
+  },
+  TTF_OpenFont: {
+    args: ["cstring", "int"],
+    returns: "pointer",
+  },
+  TTF_RenderText_Solid: {
+    args: ["pointer", "cstring", "u32"],
+    returns: "pointer",
+  },
+  TTF_SizeText: {
+    args: ["pointer", "cstring", "pointer", "pointer"],
+    returns: "int",
+  },
+  TTF_Quit: {
+    returns: "void",
+  },
+  TTF_CloseFont: {
+    args: ["pointer"],
+    returns: "void",
+  },
+});

package/src/slifer.ts

@@ -1,115 +1,126 @@
 import { libimage, libsdl, libttf } from "./ffi";
 import Global from "./global";
-import { ptr } from 'bun:ffi';
+import { ptr } from "bun:ffi";
 import Graphics from "./modules/graphics";
 import Keyboard from "./modules/keyboard";
 import Mouse from "./modules/mouse";
 
 export class SliferClass {
-
-    isRunning : boolean = true;
-
-    // Modules
-    Graphics = new Graphics();
-    Keyboard = new Keyboard();
-    Mouse = new Mouse();
-
-    constructor() {
-        const baseInit = libsdl.symbols.SDL_Init(0x00000020);
-        if (baseInit != 0) throw `SDL failed to initialize`;
-
-        const imageInit = libimage.symbols.IMG_Init(3);
-        if (imageInit != 3) throw `SDL Image failed to initialize`;
-
-        const ttfInit = libttf.symbols.TTF_Init();
-        if (ttfInit != 0) throw `SDL TTF failed to initialize`;
-
-        if (process.platform == "darwin") {
-            const tempFont = libttf.symbols.TTF_OpenFont(Buffer.from("/System/Library/Fonts/SFNSMono.ttf"), 12);
-            if (tempFont == null) throw `Default font loading failed`;
-            Global.ptrFont = tempFont;
-        }
-        
+  isRunning: boolean = true;
+
+  // Modules
+  Graphics = new Graphics();
+  Keyboard = new Keyboard();
+  Mouse = new Mouse();
+
+  constructor() {
+    const baseInit = libsdl.symbols.SDL_Init(0x00000020);
+    if (baseInit != 0) throw `SDL failed to initialize`;
+
+    const imageInit = libimage.symbols.IMG_Init(3);
+    if (imageInit != 3) throw `SDL Image failed to initialize`;
+
+    const ttfInit = libttf.symbols.TTF_Init();
+    if (ttfInit != 0) throw `SDL TTF failed to initialize`;
+
+    if (process.platform == "darwin") {
+      const tempFont = libttf.symbols.TTF_OpenFont(
+        Buffer.from("/System/Library/Fonts/SFNSMono.ttf"),
+        12,
+      );
+      if (tempFont == null) throw `Default font loading failed`;
+      Global.ptrFont = tempFont;
+    } else if (process.platform == "linux") {
+      const tempFont = libttf.symbols.TTF_OpenFont(
+        Buffer.from("/usr/share/fonts/truetype/dejavu/DejaVuSansMono.ttf"),
+        12,
+      );
+      if (tempFont == null) throw `Default font loading failed`;
+      Global.ptrFont = tempFont;
     }
-
-    /**
-     * 
-     * @param title Title of window
-     * @param width Width of window
-     * @param height Height of window
-     */
-    createWindow(title: string, width: number, height: number) : void {
-        // Creating cstring buffer from string
-        const _title = Buffer.from(title + "\x00");
-
-        // Creating window pointer
-        const _win = libsdl.symbols.SDL_CreateWindow(_title, 0x2FFF0000, 0x2FFF0000, width, height, 0);
-        if (_win == null) throw `Window creation failed`;
-        Global.ptrWindow = _win;
-
-        // Creating renderer pointer
-        const _ren = libsdl.symbols.SDL_CreateRenderer(Global.ptrWindow, -1, 0);
-        if (_ren == null) throw `Renderer Creation failed`;
-        Global.ptrRenderer = _ren;
-
-        }
-
-    /**
-     * 
-     * @returns if the window should close
-     */
-    shouldClose() : boolean {
-
-        // Clear the renderer
-        libsdl.symbols.SDL_RenderClear(Global.ptrRenderer);
-
-        // Poll Events
-        const eventArray = new Uint16Array(32);
-        const isEvent = libsdl.symbols.SDL_PollEvent(ptr(eventArray));
-
-        if (isEvent) {
-            switch (eventArray[0]) {
-                // Quit event
-                case 256:
-                    this.isRunning = false;
-                    break;
-                // Keydown event
-                case 768:
-                    const _dscancode = eventArray[8];
-                    const _dkey = libsdl.symbols.SDL_GetKeyFromScancode(_dscancode);
-                    const _dname = libsdl.symbols.SDL_GetKeyName(_dkey);
-                    Keyboard.setKeyDown(_dname.toString().toLowerCase());
-                    break;
-                // Keyup event
-                case 769:
-                    const _uscancode = eventArray[8];
-                    const _ukey = libsdl.symbols.SDL_GetKeyFromScancode(_uscancode);
-                    const _uname = libsdl.symbols.SDL_GetKeyName(_ukey);
-                    Keyboard.setKeyUp(_uname.toString().toLowerCase());
-                    break;
-                // Mouse down event
-                case 1025:
-                    const _dbtn = eventArray[8] - 256;
-                    Mouse.setButtonDown(_dbtn);
-                    break;
-                // Mouse up event
-                case 1026:
-                    const _ubtn = eventArray[8];
-                    Mouse.setButtonUp(_ubtn);
-                    break;
-            }
-        }
-
-        return !this.isRunning;
+  }
+
+  /**
+   * @param title Title of window
+   * @param width Width of window
+   * @param height Height of window
+   */
+  createWindow(title: string, width: number, height: number): void {
+    // Creating cstring buffer from string
+    const _title = Buffer.from(title + "\x00");
+
+    // Creating window pointer
+    const _win = libsdl.symbols.SDL_CreateWindow(
+      _title,
+      0x2FFF0000,
+      0x2FFF0000,
+      width,
+      height,
+      0,
+    );
+    if (_win == null) throw `Window creation failed`;
+    Global.ptrWindow = _win;
+
+    // Creating renderer pointer
+    const _ren = libsdl.symbols.SDL_CreateRenderer(Global.ptrWindow, -1, 0);
+    if (_ren == null) throw `Renderer Creation failed`;
+    Global.ptrRenderer = _ren;
+  }
+
+  /**
+   * @returns if the window should close
+   */
+  shouldClose(): boolean {
+    // Clear the renderer
+    libsdl.symbols.SDL_RenderClear(Global.ptrRenderer);
+
+    // Poll Events
+    const eventArray = new Uint16Array(32);
+    const isEvent = libsdl.symbols.SDL_PollEvent(ptr(eventArray));
+
+    if (isEvent) {
+      switch (eventArray[0]) {
+        // Quit event
+        case 256:
+          this.isRunning = false;
+          break;
+        // Keydown event
+        case 768:
+          const _dscancode = eventArray[8];
+          const _dkey = libsdl.symbols.SDL_GetKeyFromScancode(_dscancode);
+          const _dname = libsdl.symbols.SDL_GetKeyName(_dkey);
+          Keyboard.setKeyDown(_dname.toString().toLowerCase());
+          break;
+        // Keyup event
+        case 769:
+          const _uscancode = eventArray[8];
+          const _ukey = libsdl.symbols.SDL_GetKeyFromScancode(_uscancode);
+          const _uname = libsdl.symbols.SDL_GetKeyName(_ukey);
+          Keyboard.setKeyUp(_uname.toString().toLowerCase());
+          break;
+        // Mouse down event
+        case 1025:
+          const _dbtn = eventArray[8] - 256;
+          Mouse.setButtonDown(_dbtn);
+          break;
+        // Mouse up event
+        case 1026:
+          const _ubtn = eventArray[8];
+          Mouse.setButtonUp(_ubtn);
+          break;
+      }
     }
 
-    /**
-     * Slifers quit method
-     */
-    quit() {
-        libttf.symbols.TTF_CloseFont(Global.ptrFont);
-        libsdl.symbols.SDL_DestroyRenderer(Global.ptrRenderer);
-        libsdl.symbols.SDL_DestroyWindow(Global.ptrWindow);
-        libsdl.symbols.SDL_Quit();
-    }
-}
+    return !this.isRunning;
+  }
+
+  /**
+   * Slifers quit method
+   */
+  quit() {
+    libttf.symbols.TTF_CloseFont(Global.ptrFont);
+    libsdl.symbols.SDL_DestroyRenderer(Global.ptrRenderer);
+    libsdl.symbols.SDL_DestroyWindow(Global.ptrWindow);
+    libsdl.symbols.SDL_Quit();
+  }
+}