slifer 0.2.8 → 0.3.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Mohammed Salim
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Mohammed Salim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,70 +1,70 @@
-# Slifer : Native Typescript Game Framework
-
-<p align="center">
-    <img width="80%" src="https://ucarecdn.com/288f053f-61e0-42e6-804a-8c1d48a41aac/-/preview/1000x562/">
-</p>
-
-> [!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.
-
-For up to date docs, please head over to the [Slifer Webpage](https://slifer.hazyvt.com).
-
-## Introduction
-
-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)
-- [Example](#example)
-
-## Goals
-
-- 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
-- Play Audio
-
-## Future Features
-
-- Animation library
-- Save file library
-
-## Example
-
-```ts
-import Slifer, { Vector2 } from "slifer";
-
-Slifer.createWindow("Example Window", new Vector2(640, 480));
-
-const bg = Slifer.Graphics.makeColor(36, 36, 36, 255);
-
-while (!Slifer.shouldClose()) {
-    Slifer.Graphics.setBackground(bg);
-
-    if (Slifer.Keyboard.isPressed("escape")) {
-        Slifer.isRunning = false;
-    }
-
-    Slifer.Graphics.render();
-}
-
-Slifer.quit();
-```
+# Slifer : Native Typescript Game Framework
+
+<p align="center">
+    <img width="80%" src="https://ucarecdn.com/288f053f-61e0-42e6-804a-8c1d48a41aac/-/preview/1000x562/">
+</p>
+
+> [!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.
+
+For up to date docs, please head over to the [Slifer Webpage](https://slifer.hazyvt.com).
+
+## Introduction
+
+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)
+- [Example](#example)
+
+## Goals
+
+- 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
+- Play Audio
+
+## Future Features
+
+- Animation library
+- Save file library
+
+## Example
+
+```ts
+import Slifer, { Vector2 } from "slifer";
+
+Slifer.createWindow("Example Window", new Vector2(640, 480));
+
+const bg = Slifer.Graphics.makeColor(36, 36, 36, 255);
+
+while (!Slifer.shouldClose()) {
+    Slifer.Graphics.setBackground(bg);
+
+    if (Slifer.Keyboard.isPressed("escape")) {
+        Slifer.isRunning = false;
+    }
+
+    Slifer.Graphics.render();
+}
+
+Slifer.quit();
+```

package/index.ts

@@ -1,11 +1,13 @@
-import Slifer from "./src/slifer";
-import Image from "./src/engine/image";
-import Vector2 from "./src/engine/vector2";
-import Color from "./src/engine/color";
-import Audio from "./src/engine/audio";
-import Rectangle from "./src/engine/rectangle";
-import Font from "./src/engine/font";
-import Canvas from './src/engine/canvas';
-
-const slf = new Slifer();
-export { Vector2, Color, Image, Audio, Rectangle, Font, Canvas, slf as Slifer };
+import Slifer from "./src/slifer";
+import Image from "./src/engine/image";
+import Vector2 from "./src/engine/vector2";
+import Color from "./src/engine/color";
+import Audio from "./src/engine/audio";
+import Rectangle from "./src/engine/rectangle";
+import Font from "./src/engine/font";
+import Cursor from './src/engine/cursor';
+
+import { type keys } from './src/modules/keyboard';
+
+const slf = new Slifer();
+export { Vector2, Color, Image, Audio, Rectangle, Font, Cursor, slf as Slifer, type keys };

package/package.json

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

package/src/download.ts

@@ -1,27 +1,48 @@
-import * as path from 'path';
-
-const libDir = path.join(__dirname, '../libs/');
-
-async function downloadLibrary(url: string, filename: string) {
-    const response = await fetch(url);
-    await Bun.write(libDir + filename, response);
-    
-    
-}
-
-if (process.platform == "darwin") {
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2.dylib", "libSDL2.dylib");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_image.dylib", "libSDL2_image.dylib");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_mixer.dylib", "libSDL2_mixer.dylib");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_ttf.dylib", "libSDL2_ttf.dylib");
-} else if (process.platform == "win32") {
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/SDL2.dll", "SDL2.dll");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/SDL2_image.dll", "SDL2_image.dll");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/SDL2_mixer.dll", "SDL2_mixer.dll");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/SDL2_ttf.dll", "SDL2_ttf.dll");
-} else if (process.platform == "linux") {
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2.so", "libSDL2.so");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_image.so", "libSDL2_image.so");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_mixer.so", "libSDL2_mixer.so");
-    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_ttf.so", "libSDL2_ttf.so");
-}
+import * as path from 'path';
+import { parseArgs } from 'util';
+
+const libDir = path.join(__dirname, '../libs/');
+
+async function downloadLibrary(url: string, filename: string) {
+    const response = await fetch(url);
+    await Bun.write(libDir + filename, response);
+}
+
+function downloadFiles(check: string) {
+	if (check == "darwin") {
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2.dylib", "libSDL2.dylib");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_image.dylib", "libSDL2_image.dylib");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_mixer.dylib", "libSDL2_mixer.dylib");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_ttf.dylib", "libSDL2_ttf.dylib");
+	} else if (check == "win32") {
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/SDL2.dll", "SDL2.dll");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/SDL2_image.dll", "SDL2_image.dll");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/SDL2_mixer.dll", "SDL2_mixer.dll");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/SDL2_ttf.dll", "SDL2_ttf.dll");
+	} else if (check == "linux") {
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2.so", "libSDL2.so");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_image.so", "libSDL2_image.so");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_mixer.so", "libSDL2_mixer.so");
+	    downloadLibrary("https://github.com/HazyVT/Slifer/releases/download/Libraries/libSDL2_ttf.so", "libSDL2_ttf.so");
+	}
+}
+
+const { values } = parseArgs({
+	args: Bun.argv,
+	options: {
+		mode: {
+			type: 'string'
+		}
+	},
+	strict: true,
+	allowPositionals: true
+})
+
+if (values.mode == undefined) {
+	downloadFiles(process.platform);
+} else {
+	downloadFiles(values.mode);
+}
+
+
+

package/src/engine/audio.ts

@@ -1,24 +1,24 @@
-import { libmixer } from "../ffi";
-
-/** @internal */
-export default class Audio {
-    private readonly pointer;
-
-    constructor(path: string) {
-        const audiomix = libmixer.symbols.Mix_LoadWAV(
-            //@ts-expect-error Buffer error
-            Buffer.from(path + "\x00")
-        );
-
-        if (audiomix == null) throw `Failed to open wav file`;
-        this.pointer = audiomix;
-    }
-
-    public play() {
-        libmixer.symbols.Mix_PlayChannel(-1, this.pointer, 0);
-    }
-
-    public destroy() {
-        libmixer.symbols.Mix_FreeChunk(this.pointer);
-    }
+import { libmixer } from "../ffi";
+
+/** @internal */
+export default class Audio {
+    private readonly pointer;
+
+    constructor(path: string) {
+        const audiomix = libmixer.symbols.Mix_LoadWAV(
+            //@ts-expect-error Buffer error
+            Buffer.from(path + "\x00")
+        );
+
+        if (audiomix == null) throw `Failed to open wav file`;
+        this.pointer = audiomix;
+    }
+
+    public play() {
+        libmixer.symbols.Mix_PlayChannel(-1, this.pointer, 0);
+    }
+
+    public destroy() {
+        libmixer.symbols.Mix_FreeChunk(this.pointer);
+    }
 }

package/src/engine/color.ts

@@ -1,14 +1,14 @@
-/** @internal */
-export default class Color {
-    readonly r;
-    readonly g;
-    readonly b;
-    readonly a;
-
-    constructor(r: number, g: number, b: number, a: number) {
-        this.r = r;
-        this.g = g;
-        this.b = b;
-        this.a = a;
-    }
-}
+/** @internal */
+export default class Color {
+    readonly r;
+    readonly g;
+    readonly b;
+    readonly a;
+
+    constructor(r: number, g: number, b: number, a: number) {
+        this.r = r;
+        this.g = g;
+        this.b = b;
+        this.a = a;
+    }
+}

package/src/engine/cursor.ts

@@ -0,0 +1,17 @@
+import { type Pointer } from 'bun:ffi';
+import { libsdl, libimage } from '../ffi';
+
+class Cursor {
+	pointer : Pointer;
+
+	constructor(path: string) {
+		//@ts-expect-error
+		const surf = libimage.symbols.IMG_Load(Buffer.from(path+"\x00"));
+		if (surf == null) throw `Cursor surface ${path} failed`;
+		const cursor = libsdl.symbols.SDL_CreateColorCursor(surf, 0, 0);
+		if (cursor == null) throw `Cursor ${path} failed`;
+		this.pointer = cursor; 
+	}
+}
+
+export default Cursor;

package/src/engine/font.ts

@@ -1,16 +1,16 @@
-import { type Pointer } from 'bun:ffi';
-import { libttf } from '../ffi';
-
-export default class Font {
-	private pointer : Pointer;
-
-	constructor(path: string, size: number) {
-		const fp = libttf.symbols.TTF_OpenFont(Buffer.from(path+"\x00"), size);
-		if (fp == null) throw `Font failed to be opened`;
-		this.pointer = fp;
-	}
-
-	public destroy() {
-		libttf.symbols.TTF_CloseFont(this.pointer);
-	}
-}
+import { type Pointer } from 'bun:ffi';
+import { libttf } from '../ffi';
+
+export default class Font {
+	private pointer : Pointer;
+
+	constructor(path: string, size: number) {
+		const fp = libttf.symbols.TTF_OpenFont(Buffer.from(path+"\x00"), size);
+		if (fp == null) throw `Font failed to be opened`;
+		this.pointer = fp;
+	}
+
+	public destroy() {
+		libttf.symbols.TTF_CloseFont(this.pointer);
+	}
+}

package/src/engine/image.ts

@@ -1,23 +1,42 @@
-import { libimage, libsdl } from "../ffi";
-import { type Pointer, ptr, toArrayBuffer } from 'bun:ffi';
-import Render from "./render";
-
-/** @internal */
-export default class Image {
-
-    private pointer:  Pointer;
-
-    public readonly width: number;
-    public readonly height: number;
-
-    constructor(path: string) {
-        const cs = Buffer.from(path+'\x00');
-        //@ts-expect-error
-        const surface = libimage.symbols.IMG_Load(cs);
-        if (surface == null) throw `Loading ${path} failed`;
-        this.pointer = surface;
-		const dv = new DataView(toArrayBuffer(this.pointer, 0, 21));
-		this.width = dv.getUint8(16);
-		this.height = dv.getUint8(20);
-    }
-}
+import { libimage, libsdl } from "../ffi";
+import { type Pointer, ptr } from 'bun:ffi';
+import Render from "./render";
+
+/** @internal */
+export default class Image {
+
+    private pointer:  Pointer;
+    private destArray: Uint32Array;
+
+    public readonly width: number;
+    public readonly height: number;
+
+    constructor(path: string) {
+        const cs = Buffer.from(path+'\x00');
+        
+		//@ts-expect-error
+		const surface = libimage.symbols.IMG_Load(cs);
+		if (surface == null) throw `Surface load failed on image ${cs}`;
+
+		const texture = libsdl.symbols.SDL_CreateTextureFromSurface(Render.pointer, surface);
+		if (texture == null) throw `Texture load failed on image ${cs}`;
+		this.pointer = texture;
+
+		const wArr = new Uint32Array(1);
+		const hArr = new Uint32Array(1);
+		libsdl.symbols.SDL_QueryTexture(
+			texture,
+			null,
+			null,
+			ptr(wArr),
+			ptr(hArr)
+		)
+
+		this.width = wArr[0];
+		this.height = hArr[0];
+
+		this.destArray = new Uint32Array(4);
+		this.destArray[2] = this.width;
+		this.destArray[3] = this.height;
+    }
+}

package/src/engine/rectangle.ts

@@ -1,31 +1,31 @@
-import Vector2 from "./vector2";
-import { ptr, type Pointer } from 'bun:ffi';
-
-/** @internal */
-export default class Rectangle {
-    
-    public readonly position;
-    public readonly size;
-
-    constructor(position: Vector2, size: Vector2) {
-        this.position = position;
-        this.size = size;
-    }
-
-	static empty() : Rectangle {
-		return new Rectangle(new Vector2(0, 0), new Vector2(0, 0));
-	}
-
-    public isColliding(rectangle: Rectangle) : boolean {
-    	if (
-    		this.position.x < rectangle.position.x + rectangle.size.x &&
-    		this.position.x + this.size.x > rectangle.position.x &&
-    		this.position.y < rectangle.position.y + rectangle.size.y &&
-    		this.position.y + this.size.y > rectangle.position.y
-    	) {
-    		return true;
-    	}
-
-    	return false;
-    }
-}
+import Vector2 from "./vector2";
+import { ptr, type Pointer } from 'bun:ffi';
+
+/** @internal */
+export default class Rectangle {
+    
+    public position;
+    public size;
+
+    constructor(position: Vector2, size: Vector2) {
+        this.position = position;
+        this.size = size;
+    }
+
+	static empty() : Rectangle {
+		return new Rectangle(new Vector2(0, 0), new Vector2(0, 0));
+	}
+
+    public isColliding(rectangle: Rectangle) : boolean {
+    	if (
+    		this.position.x < rectangle.position.x + rectangle.size.x &&
+    		this.position.x + this.size.x > rectangle.position.x &&
+    		this.position.y < rectangle.position.y + rectangle.size.y &&
+    		this.position.y + this.size.y > rectangle.position.y
+    	) {
+    		return true;
+    	}
+
+    	return false;
+    }
+}

package/src/engine/render.ts

@@ -1,19 +1,15 @@
-import { type Pointer } from 'bun:ffi';
-import { libsdl } from "../ffi";
-import Window from "./window";
-
-/** @internal */
-export default class Render {
-
-    public static pointer : Pointer;
-    public static surface: Pointer;
-
-    public static createRenderer(width: number, height: number) {
-        const renPointer = libsdl.symbols.SDL_CreateRenderer(Window.pointer, -1, 0);
-        if (renPointer == null) throw `Renderer creation failed.`;
-        this.pointer = renPointer;
-        const surPointer = libsdl.symbols.SDL_CreateRGBSurface(0, width, height, 32, 0, 0, 0, 0)
-		if (surPointer == null) throw `Surface creation failed`;
-		this.surface = surPointer;
-    }
-}
+import { type Pointer } from 'bun:ffi';
+import { libsdl } from "../ffi";
+import Window from "./window";
+
+/** @internal */
+export default class Render {
+
+    public static pointer : Pointer;
+
+    public static createRenderer(width: number, height: number) {
+        const renPointer = libsdl.symbols.SDL_CreateRenderer(Window.pointer, -1, 0x00000004 + 0x00000002);
+        if (renPointer == null) throw `Renderer creation failed.`;
+        this.pointer = renPointer;
+    }
+}

package/src/engine/vector2.ts

@@ -1,26 +1,26 @@
-/** @internal */
-export default class Vector2 {
-    public x;
-    public y;
-
-    constructor(x: number, y: number) {
-        this.x = x;
-        this.y = y;
-    }
-
-    static one() : Vector2 {
-        return new Vector2(1, 1);
-    }
-
-    static unitX() : Vector2 {
-        return new Vector2(1, 0);
-    }
-
-    static unitY() : Vector2 {
-        return new Vector2(0, 1);
-    }
-
-    static zero() : Vector2 {
-        return new Vector2(0, 0);
-    }
+/** @internal */
+export default class Vector2 {
+    public x;
+    public y;
+
+    constructor(x: number, y: number) {
+        this.x = x;
+        this.y = y;
+    }
+
+    static one() : Vector2 {
+        return new Vector2(1, 1);
+    }
+
+    static unitX() : Vector2 {
+        return new Vector2(1, 0);
+    }
+
+    static unitY() : Vector2 {
+        return new Vector2(0, 1);
+    }
+
+    static zero() : Vector2 {
+        return new Vector2(0, 0);
+    }
 }