diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..364fdec --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +public/ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..19753cf --- /dev/null +++ b/Makefile @@ -0,0 +1,23 @@ +SHELL := /bin/bash + +ALL: build + +# `make serve` to serve the dev site on localhost. +.PHONY: serve +serve: + hugo server -D + +# `make build` to build the static documentation site. +.PHONY: build +build: + hugo + +# `make deploy` uploads the site to production. +.PHONY: deploy +deploy: + rsync -av public/ --delete-after sketchymaze.com:www/sketchymaze.com/ + +# `make clean` cleans everything up. +.PHONY: clean +clean: + rm -rf public diff --git a/config.toml b/config.toml index a22280e..9bdadf2 100644 --- a/config.toml +++ b/config.toml @@ -50,3 +50,7 @@ theme = "notebook" startLevel = 1 endLevel = 3 ordered = false + + [markup.goldmark] + [markup.goldmark.renderer] + unsafe = true diff --git a/content/about.md b/content/about.md index 780cb9c..6d74bf1 100644 --- a/content/about.md +++ b/content/about.md @@ -2,15 +2,14 @@ title: "About Sketchy Maze" draft: false --- -About Sketchy Maze. -Project: Doodle is a "drawing-based maze game" themed around hand-drawn mazes +_Sketchy Maze_ is a "drawing-based maze game" themed around hand-drawn mazes on paper. ![Screenshot of the level editor](/images/about.png) You can draw your own custom maps, freehand or with some basic drawing tools, -and then drag and drop pre-made "[doodads](doodads.md)" into your level for +and then drag and drop pre-made "[doodads](/guidebook/doodads.html)" into your level for interactive things like keys, doors and buttons. This is an **early alpha build** of the game. Longer term it will include a couple @@ -43,3 +42,12 @@ do the job and you can draw whatever shape you want for your level hazards. While the game ships with a [handful of built-in doodads](doodads.md) to spice up your level, you can also create your own and program them to do whatever you want, with JavaScript! + +## See Also + +For more information about _Sketchy Maze_, please see the following links: + +* The [Guidebook](/guidebook) site that ships as part of the game includes tons + of end user documentation and screenshots. Be sure to check it out! +* The [Frequently Asked Questions](/faq) page will offer more information in a + "Q&A" format. diff --git a/content/download.md b/content/download.md index dad34d8..664866a 100644 --- a/content/download.md +++ b/content/download.md @@ -1,5 +1,85 @@ --- title: "Download" draft: false +toc: true --- -About Sketchy Maze. +# Latest Release: v0.5.0 + +
+ Notice: v0.5.0 is still being prepared for release, most links + below will not work right now. See Previous Releases + in the mean time! +
+ +## Windows + +The Microsoft™ Windows release of _Sketchy Maze_ currently comes as a ZIP +file that you can extract anywhere and then run the `sketchymaze.exe` program to +start the game. + +**Note:** I do not yet have a code signing certificate for the Windows release, +so you may need to click through the "Unknown Publisher" warning. + +* **64-bit:** [sketchymaze-0.5.0-windows-64bit.zip](https://download.sketchymaze.com/release/v0.5.0/sketchymaze-0.5.0-windows-64bit.zip) + +[Let me know](mailto:noah@kirsle.net) if you need a 32-bit build of this game. + +--- + +## GNU/Linux + +### Flatpak (All Distros) + +The easiest cross-distro way to download _Sketchy Maze_ is via [Flatpak](https://flatpak.org/), +which is well supported on most popular Linux distributions including Fedora, Ubuntu, +Debian and others. + +```bash +# Add the Flatpak repository for this game (only needed the first time). +# NOTE: "doodle" is Sketchy Maze's internal codename, you can name this remote +# whatever you want but it should match the install command later. +$ flatpak remote-add --if-not-exists doodle https://download.sketchymaze.com/flatpak/doodle.flatpakrepo + +# Then install Sketchy Maze: +$ flatpak install doodle com.sketchymaze.Doodle + +# When there's an update, getting the latest version is simple too: +$ flatpak update +``` + +### Fedora (.rpm) + +TBD. + +### Ubuntu & Debian (.deb) + +TBD. + +### Tarball + +You can download _Sketchy Maze_ as a `.tar.gz` archive which you can extract +anywhere and run. The binary is built on a modern Fedora system and _hopefully_ +should run as-is on other modern GNU/Linux systems, but sometimes shared library +versions of SDL2 may not match your computer. + +* **64-bit:** [sketchymaze-0.5.0-linux-64bit.tar.gz](https://download.sketchymaze.com/release/v0.5.0/sketchymaze-0.5.0-linux-64bit.tar.gz) + +--- + +## Mac OS + +--- + +# Previous Releases + +## Project: Doodle v0.4.0 and Older + +Older alpha builds of Sketchy Maze (codenamed _Project: Doodle_) are available +from blog posts on the author's personal website. These releases mainly targeted +Linux and Windows with the occasional Mac OS version. + +* [Project: Doodle v0.4.0](https://www.kirsle.net/project-doodle-v0-4-0) -- _Nov 24, 2020_ +* [Project: Doodle v0.3.0](https://www.kirsle.net/project-doodle-v0-3-0) -- _Sept 19, 2020_ +* [Project: Doodle v0.2.0](https://www.kirsle.net/project-doodle-v0-2-0) -- _June 7, 2020_ +* [Project: Doodle v0.1.0](https://www.kirsle.net/doodle-v0.1.0) -- _Apr 13, 2020_ +* [Project: Doodle v0.0.10](https://www.kirsle.net/doodle) -- _July 9, 2019_ diff --git a/content/faq.md b/content/faq.md index 90b4bc5..09c50fb 100644 --- a/content/faq.md +++ b/content/faq.md @@ -7,8 +7,52 @@ About Sketchy Maze. # General -# foo +## What is _Sketchy Maze?_ -## Bar +It is a "drawing-based maze game" themed around hand-drawn maps on paper. -## Baz +With Sketchy Maze, you can draw your own levels and then play them as a +side-scrolling platformer game. You can draw maps freehand or with some basic +drawing tools (like rectangles and ellipses), specify which color lines are +"solid" and which behave like "fire" or "water," and then drag and drop various +"doodads" such as buttons and doors onto your map to add some interactive elements. + +If you're not much of a level designer, fear not! The game will also feature some +built-in levels that you can play and get some inspiration from. + +## What devices can I play it on? + +_Sketchy Maze_ is first and foremost a videogame for **desktop operating systems.** +It should run on any GNU/Linux, Microsoft Windows or Apple macOS computer. + +If you're feeling dangerous, you can also run it on GNU/Linux smartphone devices +like the Purism Librem 5 or Pine64 Pinephone. + +See the [Download](/download) page. + +# Pricing + +## Is this game free? + +Yes! + +While the game is in beta, all releases are **100% free and fully functional.** + +After the game reaches "1.0" it will use a hybrid freemium model. Free versions +of the game will include: + +* One chapter of built-in single player levels. +* The level editor where you can create and share your own custom maps, using + the built-in [doodads](/guidebook/doodads.html) that the game shipped with. + You can also play levels created by other players as long as they use the + built-in doodads. + +Paid versions of the game will include _additional_ features such as: + +* Additional chapters of built-in single player levels. +* Support for **custom doodads** in your custom levels, including the ability to + play levels made by other users which make use of custom doodads. +* Ability to **bundle** your custom doodads _with_ your level file for easy + sharing with other players. +* Possibly some access to online account features (in-game UI to share and + download levels and doodads made by others, etc.) diff --git a/static/favicon.ico b/static/favicon.ico new file mode 100644 index 0000000..d36e94b Binary files /dev/null and b/static/favicon.ico differ diff --git a/static/images/64.png b/static/images/64.png new file mode 100644 index 0000000..b98f729 Binary files /dev/null and b/static/images/64.png differ diff --git a/static/images/logo-64.png b/static/images/logo-64.png new file mode 100644 index 0000000..a0efeda Binary files /dev/null and b/static/images/logo-64.png differ diff --git a/static/images/palette.png b/static/images/palette.png new file mode 100644 index 0000000..ef15d41 Binary files /dev/null and b/static/images/palette.png differ diff --git a/themes/notebook/layouts/index.html b/themes/notebook/layouts/index.html index 72d6fa6..e4c2ed3 100644 --- a/themes/notebook/layouts/index.html +++ b/themes/notebook/layouts/index.html @@ -5,7 +5,7 @@

Welcome to SketchyMaze.com

-

f.

f.

f.

f.

f.

f.

f.

f.

+ This website is under construction. {{ end }} diff --git a/themes/notebook/layouts/partials/header.html b/themes/notebook/layouts/partials/header.html index 5bdebb9..bf763d9 100644 --- a/themes/notebook/layouts/partials/header.html +++ b/themes/notebook/layouts/partials/header.html @@ -1,6 +1,11 @@ -

Sketchy Maze

+ + + + +

Sketchy Maze

"a drawing-based maze game."
+
{{- partial "navbar.html" . -}}
diff --git a/themes/notebook/static/css/main.css b/themes/notebook/static/css/main.css index a29cd2a..9fff348 100644 --- a/themes/notebook/static/css/main.css +++ b/themes/notebook/static/css/main.css @@ -16,6 +16,12 @@ img { height: auto; } +/* Bootstrap override */ +h1,h2,h3,h4 { + margin-top: 2rem !important; + margin-bottom: 2rem !important; +} + .site-title { display: inline; margin-left: 72px; @@ -32,6 +38,20 @@ img { } } +.site-title a { + text-decoration: none; + color: #000; +} +.site-title a:hover { + text-decoration: underline; +} + +.site-logo { + position: fixed; + top: 0; + left: 0; +} + #top-nav { font-weight: bold; }