About | technologies | Features | Use | Examples | Functions | License
## :notebook: About Typesgine is engine render, controll FPS and I/O into Terminal or Browser. This project can use to create games, menus or beautiful cli programs and MORE ### Use ### NPM - Backend ```bash npm i typesgine-ascii ``` ### Static - Frontend ``` ``` ## technologies 🐱🏍🎂 - [Node](http://nodejs.org/) - Nodejs - [typescript](https://www.typescriptlang.org/) - Super Javascript ### Features - [x] [Render](#render) - [x] [FPS](#fps) - [x] [IO](#io) - [x] [CrossPlatform](#html) -> Use in Terminal or Browser ## Functions - EngineIo Main function, with which rendering, fps control and I/O are started ```typescript new typesgine.EngineIo({ fps: 60, // Frame per second frameHandler: frameHandler, // - FrameHandler.Handler callBackInput: inputHandler, // - InputHandler.Handler }); ``` - FrameHandler.Handler This function is called every frame. It's used to render. It must execute the render function that needs to receive an Array [][] / [[]] or a String containing the ASCII to be rendered. If Array [][] / [[]] dont set the width and height of the screen, the engine will set it automatically. If String set the width and height of the screen. ```typescript /// FrameHandler.Handler(callback(engineIo)) const frameHandler = (engineIo) => { engineIo.render("1234", 1, 4); }; let Graph = [ ["㊗", "2", "㊗", "㊗", "\n"], ["㊗", "㊗", "3", "㊗", "\n"], ["㊗", "4", "㊗", "㊗", "\n"], ]; const frameHandler = (engineIo) => { engineIo.render(Graph); }; ``` - InputHandler.Handler It's used to handle the input. this functions get a keypress into keyboard ```typescript /// InputHandler.Handler(callback(keyPress)) const inputHandler = (keyPress) => { console.log("KeyPress: ", keyPress); if (keyPress === "a") console.log("Moving player"); if (keyPress === "Escape") process.exit(); }; ``` ## Exemples See Folder Exemple in the root of the project to see how to use the engine. ### Simple Game ```js import typesgine from "typesgine-ascii"; console.clear(); // Game state let playerX = 12; // Player's x position let score = 0; let gameOver = false; const width = 24; const height = 16; let items = []; // Array to store falling items // Item types: 1 = collectible (point), 2 = obstacle (damage) function createItem() { return { x: Math.floor(Math.random() * width), y: 0, type: Math.random() > 0.3 ? 1 : 2 }; } // Initialize some items for (let i = 0; i < 3; i++) { items.push(createItem()); } const render = () => { // Create empty game board let board = Array(height) .fill() .map(() => Array(width).fill(0)); if (!gameOver) { // Update items items.forEach(item => { item.y += 0.5; // Move items down if (item.y >= height) { items = items.filter(i => i !== item); // Remove items that reach bottom items.push(createItem()); // Add new item } // Check collision with player if (Math.floor(item.y) === height - 1 && item.x === playerX) { if (item.type === 1) { score += 10; } else { gameOver = true; } } // Render items if (item.y < height) { const y = Math.floor(item.y); if (item.type === 1) { board[y][item.x] = 3; // Collectible } else { board[y][item.x] = 4; // Obstacle } } }); // Render player board[height - 1][playerX] = 1; } // Add score display if (gameOver) { const gameOverText = "Game Over! Score: " + score; for (let i = 0; i < gameOverText.length; i++) { board[7][6 + i] = gameOverText.charCodeAt(i); } } else { const scoreText = "Score: " + score; for (let i = 0; i < scoreText.length; i++) { board[0][1 + i] = scoreText.charCodeAt(i); } } return board; }; const frameHandler = typesgine.FrameHandler.Handler((engineIo) => { engineIo.render(render(), width, height); }); const inputHandler = typesgine.InputHandler.Handler((keyPress) => { if (!gameOver) { if (keyPress === "a" && playerX > 0) { playerX--; // Move left } if (keyPress === "d" && playerX < width - 1) { playerX++; // Move right } } if (keyPress === "q") { process.exit(); // Quit game } }); new typesgine.EngineIo({ fps: 10, frameHandler: frameHandler, callBackInput: inputHandler, }); ``` ### Simplest example using Array ```javascript import typesgine from "typesgine-ascii"; console.clear(); const render = () => { let final = [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], ]; for (let i = 0; i < 8; i++) { for (let j = 0; j < 24; j++) { final[i][j] = Math.round(Math.random() * (0 - 9) + 9); } final[i][final[i].length - 1] = "\n"; } return final; }; const frameHandler = (engineIo) => { engineIo.render(render(), 24, 16); }; const inputHandler = (keyPress) => { console.log("KeyPress: ", keyPress); }; new typesgine.EngineIo({ fps: 60, frameHandler: frameHandler, callBackInput: inputHandler, }); ``` ### Simplest example using String ```typescript import typesgine from "typesgine-ascii"; console.clear(); const render = () => { let final = ""; for (let i = 0; i < 16; i++) { for (let j = 0; j < 24; j++) { final += `${Math.round(Math.random() * (0 - 9) + 9)}`; } } return final; }; const frameHandler = (engineIo) => { engineIo.render(render(), 24, 16); }; const inputHandler = (keyPress) => { console.log("KeyPress: ", keyPress); }; new typesgine.EngineIo({ fps: 60, frameHandler: frameHandler, callBackInput: inputHandler, }); ``` ### Html Exemple ```html