slifer 0.1.9 → 0.2.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,66 +1,66 @@
-# Slifer : Native Typescript Game Framework
-
-<p align="center">
-    <img width="80%" src="./logo-alpha.png">
-</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.
-
-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
-
-## Future Features
-
-- Audio Implementation
-- Animation library
-- Save file library
-
-## Example
-
-```ts
-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);
-
-  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="./logo-alpha.png">
+</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.
+
+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
+
+## Future Features
+
+- Audio Implementation
+- Animation library
+- Save file library
+
+## Example
+
+```ts
+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);
+
+  if (Slifer.Keyboard.isPressed("escape")) {
+    Slifer.isRunning = false;
+  }
+
+  Slifer.Graphics.render();
+}
+
+Slifer.quit();
+```

package/index.ts

@@ -1,4 +1,4 @@
-import { SliferClass } from "./src/slifer";
-
-const Slifer = new SliferClass();
+import { SliferClass } from "./src/slifer";
+
+const Slifer = new SliferClass();
 export default Slifer;

package/package.json

@@ -1,14 +1,14 @@
-{
-  "name": "slifer",
-  "version": "0.1.9",
-  "description": "A game framework made for bun and typescript",
-  "module": "index.ts",
-  "devDependencies": {
-    "@types/bun": "latest",
-    "typedoc": "^0.26.7"
-  },
-  "peerDependencies": {
-    "typescript": "^5.0.0"
-  },
-  "type": "module"
-}
+{
+    "name": "slifer",
+    "version": "0.2.0",
+    "description": "A game framework made for bun and typescript",
+    "module": "index.ts",
+    "devDependencies": {
+        "@types/bun": "latest",
+        "typedoc": "^0.26.7"
+    },
+    "peerDependencies": {
+        "typescript": "^5.0.0"
+    },
+    "type": "module"
+}

package/src/color.ts

@@ -0,0 +1,15 @@
+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;
+    }
+}
+
+export default Color;

package/src/engine/rectangle.ts

@@ -0,0 +1,25 @@
+import { ptr } from "bun:ffi";
+import Vector2 from "./vector";
+
+class Rectangle {
+    private readonly pointer;
+    public position: Vector2;
+    public size: Vector2;
+
+    constructor(position: Vector2, size: Vector2) {
+        const arr = new Uint32Array(4);
+        arr[0] = position.x;
+        arr[1] = position.y;
+        arr[2] = size.x;
+        arr[3] = size.y;
+        this.pointer = ptr(arr);
+        this.position = position;
+        this.size = size;
+    }
+
+    static empty() {
+        return new Rectangle(new Vector2(0, 0), new Vector2(0, 0));
+    }
+}
+
+export default Rectangle;

package/src/engine/vector.ts

@@ -0,0 +1,49 @@
+class Vector2 {
+    public x;
+    public y;
+
+    constructor(x: number, y: number) {
+        this.x = x;
+        this.y = y;
+    }
+
+    /**
+     * Creates a Vector2 with the components 1,1
+     */
+    static one() {
+        return new Vector2(1, 1);
+    }
+
+    /**
+     * Creates a Vector2 with the components 1,0
+     */
+    static unitX() {
+        return new Vector2(1, 0);
+    }
+
+    /**
+     * Creates a Vector2 with the components 0,1
+     */
+    static unitY() {
+        return new Vector2(0, 1);
+    }
+
+    /**
+     * Creates a vector2 with component 0,0
+     */
+    static zero() {
+        return new Vector2(0, 0);
+    }
+
+    /**
+     * Adds two vectors together
+     *
+     * @param vec1 Vector2 object
+     * @param vec2 Vector2 object
+     */
+    static add(vec1: Vector2, vec2: Vector2) {
+        return new Vector2(vec1.x + vec2.x, vec1.y + vec2.y);
+    }
+}
+
+export default Vector2;

package/src/engine.ts

@@ -0,0 +1,24 @@
+import { libsdl, libimage, libttf } from "./ffi";
+import Global from "./global";
+
+//@ts-expect-error
+const fontFile = await import("./Jost-Bold.ttf");
+
+export function initLibraries(): void {
+    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`;
+
+    const tempFont = libttf.symbols.TTF_OpenFont(
+        Buffer.from(fontFile.default),
+        24
+    );
+
+    if (tempFont == null) throw `Default font loading failed`;
+    Global.ptrFont = tempFont;
+}