create-asciitorium 0.1.41 → 0.1.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +13 -32
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # create-asciitorium
2
2
 
3
- `create-asciitorium` is a command-line tool that helps you quickly scaffold a new [asciitorium](https://github.com/iroknee/asciitorium) project. It sets up all the necessary files, folders, and dependencies so you can start building CLUI applications with minimal setup.
3
+ `create-asciitorium` is a command-line tool that helps you quickly scaffold a new [asciitorium](https://github.com/iroknee/asciitorium) project. It sets up all the necessary files, folders, and dependencies so you can start building a Command-Line User Interface (CLUI) application with minimal setup.
4
4
 
5
5
  ## Features
6
6
 
@@ -41,7 +41,7 @@ npm run build
41
41
 
42
42
  ### Other Scripts
43
43
 
44
- Asciitorium supports viewing ascii art files. There are a few easy ways to create some specific ascii art, including FIGlet fonts and maps.
44
+ `create-asciitorium` contains a few scripts that helps get building asciitorium `.art` files.
45
45
 
46
46
  To generate FIGlet ASCII art assets (automatically placed in public/art):
47
47
 
@@ -54,48 +54,27 @@ npm run figlet font "a phrase"
54
54
  Here are some practical examples for generating ASCII art:
55
55
 
56
56
  ```bash
57
- # Generate a game title
58
- npm run figlet big "DUNGEON QUEST"
59
-
60
- # Create a welcome message
61
- npm run figlet standard "Welcome"
62
-
63
57
  # Generate stylized text for menus
64
58
  npm run figlet small "Main Menu"
65
59
 
66
- # Create decorative headers
67
- npm run figlet banner "Level 1"
68
-
69
60
  # Generate large title text
70
61
  npm run figlet block "GAME OVER"
71
62
  ```
72
63
 
73
- #### Popular FIGlet Fonts
74
-
75
- Some commonly used fonts include:
76
-
77
- - `big` - Large, bold letters
78
- - `standard` - Default FIGlet font
79
- - `small` - Compact text
80
- - `banner` - Wide banner-style text
81
- - `block` - Solid block letters
82
- - `slant` - Italicized appearance
83
- - `shadow` - Text with shadow effect
84
-
85
- You may also list all available FIGlet fonts supported:
64
+ You may list all available FIGlet fonts supported:
86
65
 
87
66
  ```bash
88
67
  npm run figlet:fonts
89
68
  ```
90
69
 
91
- To generate ASCII maze files (placed in public/art/mazes):
70
+ To generate asciitorium map files (placed in public/art/maps):
92
71
 
93
72
  ```bash
94
- node scripts/maze-builder.js <width> <height> <filename> [--smooth]
73
+ node scripts/map-builder.js <width> <height> <filename> [--smooth]
95
74
 
96
75
  # Examples:
97
- node scripts/maze-builder.js 10 10 dungeon-level-1.art
98
- node scripts/maze-builder.js 15 20 castle-maze.art --smooth
76
+ node scripts/map-builder.js 10 10 dungeon-level-1.art
77
+ node scripts/map-builder.js 15 20 castle-maze.art --smooth
99
78
  ```
100
79
 
101
80
  The `--smooth` flag uses Unicode box drawing characters for improved visual appearance.
@@ -105,14 +84,16 @@ The `--smooth` flag uses Unicode box drawing characters for improved visual appe
105
84
  A typical generated project will look like:
106
85
 
107
86
  ```bash
108
- my-asciitorium-app/
87
+ my-app/
109
88
  ├── public/
110
89
  │ ├── art/
111
- │ │ └── mazes/ # Generated maze files
112
- │ └── fonts/ # Custom fonts
90
+ │ │ └── maps/ # asciitorium map/legend files.
91
+ └── materials/ # asciitorium 3D & 2D scenery files
92
+ │ │ └── fonts/ # asciitorium font files
93
+ │ │ └── sprites/ # asciitorium sprite files
113
94
  ├── scripts/
114
95
  │ ├── gen-figlet-art.js # FIGlet art generator
115
- │ └── maze-builder.js # ASCII maze generator
96
+ │ └── map-builder.js # asciitorium map generator
116
97
  ├── src/
117
98
  │ ├── main.tsx # Main application entry
118
99
  │ └── vite-env.d.ts # TypeScript definitions
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-asciitorium",
3
- "version": "0.1.41",
3
+ "version": "0.1.42",
4
4
  "private": false,
5
5
  "description": "Scaffold a Vite + TypeScript project prewired for asciitorium (web + cli).",
6
6
  "bin": {