Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
4 changes: 4 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

236 changes: 3 additions & 233 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,233 +1,3 @@
# Gameface Starter Guide

Gameface is for developers who’d like to utilize modern HTML5 and JavaScript to create a game user interface. Gameface shortens development time by allowing you to use modern and widely available technologies.

This tutorial provides a hands-on introduction to building UI with Gameface. By the end of it, you will have created a beautiful and functioning UI with a HUD and a Pause Menu.


## Directory structure

```
│ README.md
├───files
│ │ .gitignore
│ │
│ ├───chapter_1
│ │ │ chapter_1.zip
│ │ │ cohtml.js
│ │ │ index.html
│ │ │ script.js
│ │ │ style.css
│ │ │
│ │ └───assets
│ │
│ │
│ ├───chapter_2
│ │ │ chapter_2.zip
│ │ │ cohtml.js
│ │ │ index.html
│ │ │ model.js
│ │ │ script.js
│ │ │ style.css
│ │ │
│ │ └───assets
│ │
│ │
│ ├───chapter_3
│ │ │ chapter_3.zip
│ │ │ cohtml.js
│ │ │ index.html
│ │ │ model.js
│ │ │ script.js
│ │ │ style.css
│ │ │
│ │ └───assets
│ │
│ │
│ ├───chapter_4
│ │ │ chapter_4.zip
│ │ │ cohtml.js
│ │ │ index.html
│ │ │ model.js
│ │ │ script.js
│ │ │ style.css
│ │ │
│ │ └───assets
│ │
│ │
│ ├───chapter_5
│ │ │ chapter_5.zip
│ │ │ cohtml.js
│ │ │ index.html
│ │ │ model.js
│ │ │ script.js
│ │ │ style.css
│ │ │
│ │ └───assets
│ │
│ │
│ ├───chapter_6
│ │ │ chapter_6.zip
│ │ │ cohtml.js
│ │ │ index.html
│ │ │ model.js
│ │ │ package-lock.json
│ │ │ package.json
│ │ │ script.js
│ │ │ style.css
│ │ │
│ │ ├───assets
│ │
│ │
│ ├───chapter_7
│ │ │ chapter_7.zip
│ │ │ cohtml.js
│ │ │ index.html
│ │ │ model.js
│ │ │ package-lock.json
│ │ │ package.json
│ │ │ script.js
│ │ │ style.css
│ │ │
│ │ ├───assets
│ │
│ │
│ ├───chapter_8
│ │ │ chapter_8.zip
│ │ │ cohtml.js
│ │ │ index.html
│ │ │ model.js
│ │ │ package-lock.json
│ │ │ package.json
│ │ │ script.js
│ │ │ style.css
│ │ │
│ │ ├───assets
│ │
│ │
│ └───chapter_9
│ │ chapter_9.zip
│ │ cohtml.js
│ │ index.html
│ │ model.js
│ │ package-lock.json
│ │ package.json
│ │ poi-data-binding.js
│ │ script.js
│ │ style.css
│ │
│ ├───assets
└───guide
│ .editorconfig
│ .eslintignore
│ .eslintrc.json
│ .gitignore
│ .markdownlint.json
│ .markdownlintignore
│ .stylelintignore
│ .stylelintrc.json
│ babel.config.js
│ netlify.toml
│ package-lock.json
│ package.json
│ README.md
│ theme.toml
├───assets
│ ├───js
│ │
│ │
│ └───scss
├───config
│ │ postcss.config.js
│ │
│ ├───next
│ │ config.toml
│ │
│ ├───production
│ │ config.toml
│ │
│ └───_default
│ config.toml
│ menus.toml
│ params.toml
├───content
│ │ _index.md
│ │
│ └───chapters
│ │ _index.md
│ │
│ ├───chapter-1
│ │
│ ├───chapter-10
│ │
│ ├───chapter-2
│ │
│ ├───chapter-3
│ │
│ ├───chapter-4
│ │
│ ├───chapter-5
│ │
│ ├───chapter-6
│ │
│ ├───chapter-7
│ │
│ ├───chapter-8
│ │
│ └───chapter-9
├───functions
├───layouts
│ │ index.html
│ │
│ ├───chapters
│ │ list.html
│ │ single.html
│ │
│ ├───partials
│ │
│ │
│ └───shortcodes
```

## Adding files to the chapters

You can add new files for the chapters inside the files folder.

**Keep in mind that if you change any of the existing chapters you will need to archive them again**

## Changing the guide content

To change the guide content you need to edit the `md` files in the `/guide/content` directory.

For more information refer to the `README` in the `/guide` folder.

## Credit

### Fonts
The font used for this guide is [Jost*](https://indestructibletype.com/Jost.html)

### Images

The images used for this guide are the following:

- [Arrow flights icon](https://game-icons.net/1x1/lorc/arrow-flights.html) by [Lorc](https://lorcblog.blogspot.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [War axe icon](https://game-icons.net/1x1/delapouite/war-axe.html) by [Delapouite](https://delapouite.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Beer stein icon](https://game-icons.net/1x1/lorc/beer-stein.html) by [Lorc](https://lorcblog.blogspot.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Pocket bow icon](https://game-icons.net/1x1/lorc/pocket-bow.html) by [Lorc](https://lorcblog.blogspot.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Check mark icon](https://game-icons.net/1x1/delapouite/check-mark.html) by [Delapouite](https://delapouite.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Brutal helm icon](https://game-icons.net/1x1/carl-olsen/brutal-helm.html) by [Carl Olsen](https://twitter.com/unstoppableCarl) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Padlock icon](https://game-icons.net/1x1/lorc/padlock.html) by [Lorc](https://lorcblog.blogspot.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Angel wings icon](https://game-icons.net/1x1/lorc/angel-wings.html) by [Lorc](https://lorcblog.blogspot.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Church icon](https://game-icons.net/1x1/delapouite/church.html) by [Delapouite](https://delapouite.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Village icon](https://game-icons.net/1x1/delapouite/village.html) by [Delapouite](https://delapouite.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
- [Spear hook icon](https://game-icons.net/1x1/lorc/spear-hook.html) by [Lorc](https://lorcblog.blogspot.com/) under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
# Gameface Content Creation Guide

Info incoming
38 changes: 38 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import coherentTheme from 'coherent-docs-theme';
import { content } from './src/data/content';

export default defineConfig({
integrations: [
starlight({
title: 'UI workflow guide',
social: [
{
icon: 'laptop',
label: 'Site',
href: 'https://coherent-labs.com/',
},
{
icon: 'email',
label: 'Email',
href: 'https://coherent-labs.com/get-in-touch'
},
],
plugins: [
...coherentTheme({
documentationSearchTag: 'UI workflow guide',
showPageProgress: true,
})],
customCss: ['./src/styles/custom.css'],
sidebar: content.map((topic) => {
return {
label: topic.heading,
autogenerate: { directory: topic.link.split('/')[1] },
collapsed: !topic.current,
}
})
}),
],
});
1 change: 0 additions & 1 deletion files/.gitignore

This file was deleted.

Binary file removed files/chapter_1/assets/Jost-400-Book.ttf
Binary file not shown.
Binary file removed files/chapter_1/assets/arrow.png
Binary file not shown.
Binary file removed files/chapter_1/assets/axe.png
Binary file not shown.
Binary file removed files/chapter_1/assets/beer.png
Binary file not shown.
Binary file removed files/chapter_1/assets/bow.png
Binary file not shown.
Binary file removed files/chapter_1/assets/check-empty.png
Binary file not shown.
Binary file removed files/chapter_1/assets/check-mark.png
Binary file not shown.
Binary file removed files/chapter_1/assets/helmet.png
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_1.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_10.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_11.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_12.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_13.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_14.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_15.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_16.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_17.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_18.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_19.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_2.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_20.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_21.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_22.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_23.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_24.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_25.jpg
Binary file not shown.
Binary file removed files/chapter_1/assets/map-1_26.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_27.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_28.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_29.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_3.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_30.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_31.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_32.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_33.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_34.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_35.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_36.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_37.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_38.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_39.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_4.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_40.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_41.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_42.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_43.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_44.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_45.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_46.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_47.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_48.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_49.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_5.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_50.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_51.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_52.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_53.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_54.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_55.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_56.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_57.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_58.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_59.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_6.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_60.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_61.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_62.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_63.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_64.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_7.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_8.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-1_9.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/map-locked-icon.png
Diff not rendered.
Binary file removed files/chapter_1/assets/map-statue-icon.png
Diff not rendered.
Binary file removed files/chapter_1/assets/map-town-icon.png
Diff not rendered.
Binary file removed files/chapter_1/assets/map-village-icon.png
Diff not rendered.
Binary file removed files/chapter_1/assets/minimap.jpg
Diff not rendered.
Binary file removed files/chapter_1/assets/spear.png
Diff not rendered.
Binary file removed files/chapter_1/chapter_1.zip
Binary file not shown.
Loading