diff --git a/404.html b/404.html index 4a82f62a..01cebf2b 100644 --- a/404.html +++ b/404.html @@ -23,7 +23,7 @@

Appearance

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home
- + \ No newline at end of file diff --git a/assets/index.md.86565ca9.js b/assets/index.md.dee1ce40.js similarity index 94% rename from assets/index.md.86565ca9.js rename to assets/index.md.dee1ce40.js index 59f75e8d..abe465e6 100644 --- a/assets/index.md.86565ca9.js +++ b/assets/index.md.dee1ce40.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.1169fbc9.js";const d=JSON.parse(`{"title":"The Paper Pilot","description":"","frontmatter":{"title":"The Paper Pilot","layout":"home","hero":{"name":"The Paper Pilot","tagline":"I'm Anthony, or The Paper Pilot, and I make fun games and tools!","actions":[{"theme":"brand","text":"My Projects","link":"/projects/"},{"theme":"alt","text":"My Resume","link":"https://resume.incremental.social/thepaperpilot/thepaperpilot"}]},"features":[{"icon":"🧑‍💻","title":"Profectus","details":"A game engine that grows with you","link":"https://moddingtree.com"},{"icon":"👤","title":"Incremental Social","details":"A kind social media site for the incremental games community","link":"https://incremental.social"},{"icon":"🎮","title":"My Games","details":"Most of my games are playable on Itch","link":"https://thepaperpilot.itch.io"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1701138719000}`),i={name:"index.md"};function o(n,s,l,r,c,m){return t(),a("div")}const h=e(i,[["render",o]]);export{d as __pageData,h as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.1169fbc9.js";const d=JSON.parse(`{"title":"The Paper Pilot","description":"","frontmatter":{"title":"The Paper Pilot","layout":"home","hero":{"name":"The Paper Pilot","tagline":"I'm Anthony, or The Paper Pilot, and I make fun games and tools!","actions":[{"theme":"brand","text":"My Projects","link":"/projects/"},{"theme":"alt","text":"My Resume","link":"https://resume.incremental.social/thepaperpilot/thepaperpilot"}]},"features":[{"icon":"🧑‍💻","title":"Profectus","details":"A game engine that grows with you","link":"https://moddingtree.com"},{"icon":"👤","title":"Incremental Social","details":"A kind social media site for the incremental games community","link":"https://incremental.social"},{"icon":"🎮","title":"My Games","details":"Most of my games are playable on Itch","link":"https://thepaperpilot.itch.io"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1701441563000}`),i={name:"index.md"};function o(n,s,l,r,c,m){return t(),a("div")}const h=e(i,[["render",o]]);export{d as __pageData,h as default}; diff --git a/assets/index.md.86565ca9.lean.js b/assets/index.md.dee1ce40.lean.js similarity index 94% rename from assets/index.md.86565ca9.lean.js rename to assets/index.md.dee1ce40.lean.js index 59f75e8d..abe465e6 100644 --- a/assets/index.md.86565ca9.lean.js +++ b/assets/index.md.dee1ce40.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.1169fbc9.js";const d=JSON.parse(`{"title":"The Paper Pilot","description":"","frontmatter":{"title":"The Paper Pilot","layout":"home","hero":{"name":"The Paper Pilot","tagline":"I'm Anthony, or The Paper Pilot, and I make fun games and tools!","actions":[{"theme":"brand","text":"My Projects","link":"/projects/"},{"theme":"alt","text":"My Resume","link":"https://resume.incremental.social/thepaperpilot/thepaperpilot"}]},"features":[{"icon":"🧑‍💻","title":"Profectus","details":"A game engine that grows with you","link":"https://moddingtree.com"},{"icon":"👤","title":"Incremental Social","details":"A kind social media site for the incremental games community","link":"https://incremental.social"},{"icon":"🎮","title":"My Games","details":"Most of my games are playable on Itch","link":"https://thepaperpilot.itch.io"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1701138719000}`),i={name:"index.md"};function o(n,s,l,r,c,m){return t(),a("div")}const h=e(i,[["render",o]]);export{d as __pageData,h as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.1169fbc9.js";const d=JSON.parse(`{"title":"The Paper Pilot","description":"","frontmatter":{"title":"The Paper Pilot","layout":"home","hero":{"name":"The Paper Pilot","tagline":"I'm Anthony, or The Paper Pilot, and I make fun games and tools!","actions":[{"theme":"brand","text":"My Projects","link":"/projects/"},{"theme":"alt","text":"My Resume","link":"https://resume.incremental.social/thepaperpilot/thepaperpilot"}]},"features":[{"icon":"🧑‍💻","title":"Profectus","details":"A game engine that grows with you","link":"https://moddingtree.com"},{"icon":"👤","title":"Incremental Social","details":"A kind social media site for the incremental games community","link":"https://incremental.social"},{"icon":"🎮","title":"My Games","details":"Most of my games are playable on Itch","link":"https://thepaperpilot.itch.io"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1701441563000}`),i={name:"index.md"};function o(n,s,l,r,c,m){return t(),a("div")}const h=e(i,[["render",o]]);export{d as __pageData,h as default}; diff --git a/assets/projects_babble_index.md.346c2b79.js b/assets/projects_babble_index.md.600d0df4.js similarity index 98% rename from assets/projects_babble_index.md.346c2b79.js rename to assets/projects_babble_index.md.600d0df4.js index cea85e20..1c0661f1 100644 --- a/assets/projects_babble_index.md.346c2b79.js +++ b/assets/projects_babble_index.md.600d0df4.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.1169fbc9.js";const s="/assets/screenshot.3bf794a2.png",o="/assets/babblemmscreenshot.7646b6c2.png",g=JSON.parse('{"title":"Babble Buds","description":"","frontmatter":{"title":"Babble Buds"},"headers":[],"relativePath":"projects/babble/index.md","filePath":"projects/babble/index.md","lastUpdated":1701138719000}'),n={name:"projects/babble/index.md"},i=r('

Babble Buds ​

Babble Buds Homepage

Source Code:

Babble buds is a free, open-source virtual puppet show software. It is heavily based on the non-public software called "Puppet Pals", used in URealms Live. The software is written in javascript using React, a rendering library called PIXI.js, and electron.

Users can create puppets with different faces for different emotions, and then use the puppet on a stage where you and other users can each make your respective puppets move, change emotions, and "babble" at each other. The stage has a green screen feature and can be popped out, which gives the users tons of possibilities in terms of using the program for a role-playing live stream, faux video chatting with friends, game development, or whatever else you want!

Users can connect to the public server and create private rooms so that they and their friends can see each other's puppets and use the software however they please. For the security conscious, you can also use the server's source code to self-host your private server.

Babble Buds Screenshot

Engine ​

The engine originally made to make the Babble Buds program was separated into a separate engine called babble.js, so that projects created in Babble Buds can be used in other projects. For example, a game can create puppets in Babble Buds and then use them for cutscenes or player agency inside of the game. Additionally, it has been ported to C# (called babble.cs) for use with Unity, for the same kinds of purposes. You can check out Tower Offense for a pixi.js game using Babble Buds puppets for the cutscenes, or Dice Armor for a unity game using Babble Buds puppets for the cutscenes.

Babble Movie Maker ​

Babble Movie Maker is a cutscene editor for Babble Buds puppets. You open a babble buds project in it, and you can add actors to a stage and have them move and change expressions, etc., on a timeline. You can then use the cutscene in a game using babble.js or babble.cs, or export the cutscene into a video file. There is even support for defining custom commands with custom fields, so that if you've expanded upon the default actions provided in babble.js or babble.cs, you can still use Movie Maker to create your cutscenes.

Babble MM Screenshot

',13),b=[i];function c(l,p,d,h,u,f){return a(),t("div",null,b)}const B=e(n,[["render",c]]);export{g as __pageData,B as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.1169fbc9.js";const s="/assets/screenshot.3bf794a2.png",o="/assets/babblemmscreenshot.7646b6c2.png",g=JSON.parse('{"title":"Babble Buds","description":"","frontmatter":{"title":"Babble Buds"},"headers":[],"relativePath":"projects/babble/index.md","filePath":"projects/babble/index.md","lastUpdated":1701441563000}'),n={name:"projects/babble/index.md"},i=r('

Babble Buds ​

Babble Buds Homepage

Source Code:

Babble buds is a free, open-source virtual puppet show software. It is heavily based on the non-public software called "Puppet Pals", used in URealms Live. The software is written in javascript using React, a rendering library called PIXI.js, and electron.

Users can create puppets with different faces for different emotions, and then use the puppet on a stage where you and other users can each make your respective puppets move, change emotions, and "babble" at each other. The stage has a green screen feature and can be popped out, which gives the users tons of possibilities in terms of using the program for a role-playing live stream, faux video chatting with friends, game development, or whatever else you want!

Users can connect to the public server and create private rooms so that they and their friends can see each other's puppets and use the software however they please. For the security conscious, you can also use the server's source code to self-host your private server.

Babble Buds Screenshot

Engine ​

The engine originally made to make the Babble Buds program was separated into a separate engine called babble.js, so that projects created in Babble Buds can be used in other projects. For example, a game can create puppets in Babble Buds and then use them for cutscenes or player agency inside of the game. Additionally, it has been ported to C# (called babble.cs) for use with Unity, for the same kinds of purposes. You can check out Tower Offense for a pixi.js game using Babble Buds puppets for the cutscenes, or Dice Armor for a unity game using Babble Buds puppets for the cutscenes.

Babble Movie Maker ​

Babble Movie Maker is a cutscene editor for Babble Buds puppets. You open a babble buds project in it, and you can add actors to a stage and have them move and change expressions, etc., on a timeline. You can then use the cutscene in a game using babble.js or babble.cs, or export the cutscene into a video file. There is even support for defining custom commands with custom fields, so that if you've expanded upon the default actions provided in babble.js or babble.cs, you can still use Movie Maker to create your cutscenes.

Babble MM Screenshot

',13),b=[i];function c(l,p,d,h,u,f){return a(),t("div",null,b)}const B=e(n,[["render",c]]);export{g as __pageData,B as default}; diff --git a/assets/projects_babble_index.md.346c2b79.lean.js b/assets/projects_babble_index.md.600d0df4.lean.js similarity index 88% rename from assets/projects_babble_index.md.346c2b79.lean.js rename to assets/projects_babble_index.md.600d0df4.lean.js index 2a1c593d..282d40b8 100644 --- a/assets/projects_babble_index.md.346c2b79.lean.js +++ b/assets/projects_babble_index.md.600d0df4.lean.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.1169fbc9.js";const s="/assets/screenshot.3bf794a2.png",o="/assets/babblemmscreenshot.7646b6c2.png",g=JSON.parse('{"title":"Babble Buds","description":"","frontmatter":{"title":"Babble Buds"},"headers":[],"relativePath":"projects/babble/index.md","filePath":"projects/babble/index.md","lastUpdated":1701138719000}'),n={name:"projects/babble/index.md"},i=r("",13),b=[i];function c(l,p,d,h,u,f){return a(),t("div",null,b)}const B=e(n,[["render",c]]);export{g as __pageData,B as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.1169fbc9.js";const s="/assets/screenshot.3bf794a2.png",o="/assets/babblemmscreenshot.7646b6c2.png",g=JSON.parse('{"title":"Babble Buds","description":"","frontmatter":{"title":"Babble Buds"},"headers":[],"relativePath":"projects/babble/index.md","filePath":"projects/babble/index.md","lastUpdated":1701441563000}'),n={name:"projects/babble/index.md"},i=r("",13),b=[i];function c(l,p,d,h,u,f){return a(),t("div",null,b)}const B=e(n,[["render",c]]);export{g as __pageData,B as default}; diff --git a/assets/projects_citadel_index.md.107fdf79.js b/assets/projects_citadel_index.md.e4de060a.js similarity index 94% rename from assets/projects_citadel_index.md.107fdf79.js rename to assets/projects_citadel_index.md.e4de060a.js index 59872456..e8074ffb 100644 --- a/assets/projects_citadel_index.md.107fdf79.js +++ b/assets/projects_citadel_index.md.e4de060a.js @@ -1 +1 @@ -import{_ as a,o as r,c as s,k as e,a as t}from"./chunks/framework.1169fbc9.js";const n="/assets/screenshot.f2631300.png",C=JSON.parse('{"title":"Capture the Citadel","description":"","frontmatter":{"title":"Capture the Citadel"},"headers":[],"relativePath":"projects/citadel/index.md","filePath":"projects/citadel/index.md","lastUpdated":1701138719000}'),o={name:"projects/citadel/index.md"},i=e("h1",{id:"capture-the-citadel",tabindex:"-1"},[t("Capture the Citadel "),e("a",{class:"header-anchor",href:"#capture-the-citadel","aria-label":'Permalink to "Capture the Citadel"'},"​")],-1),c=e("p",null,"A 3D VR re-envisioning of a Slay the Spire-style game by Anthony Lawn and Grant Barbee for their VR class in college's final project.",-1),l=e("p",null,[t("For more details, visit "),e("a",{href:"https://grantcbarbee.github.io/conquer-the-citadel.html",target:"_blank",rel:"noreferrer"},"Grant's page on the game"),t(".")],-1),d=e("p",null,[e("img",{src:n,alt:"Screenshot"})],-1),h=[i,c,l,d];function p(_,m,u,f,g,x){return r(),s("div",null,h)}const k=a(o,[["render",p]]);export{C as __pageData,k as default}; +import{_ as a,o as r,c as s,k as e,a as t}from"./chunks/framework.1169fbc9.js";const n="/assets/screenshot.f2631300.png",C=JSON.parse('{"title":"Capture the Citadel","description":"","frontmatter":{"title":"Capture the Citadel"},"headers":[],"relativePath":"projects/citadel/index.md","filePath":"projects/citadel/index.md","lastUpdated":1701441563000}'),o={name:"projects/citadel/index.md"},i=e("h1",{id:"capture-the-citadel",tabindex:"-1"},[t("Capture the Citadel "),e("a",{class:"header-anchor",href:"#capture-the-citadel","aria-label":'Permalink to "Capture the Citadel"'},"​")],-1),c=e("p",null,"A 3D VR re-envisioning of a Slay the Spire-style game by Anthony Lawn and Grant Barbee for their VR class in college's final project.",-1),l=e("p",null,[t("For more details, visit "),e("a",{href:"https://grantcbarbee.github.io/conquer-the-citadel.html",target:"_blank",rel:"noreferrer"},"Grant's page on the game"),t(".")],-1),d=e("p",null,[e("img",{src:n,alt:"Screenshot"})],-1),h=[i,c,l,d];function p(_,m,u,f,g,x){return r(),s("div",null,h)}const k=a(o,[["render",p]]);export{C as __pageData,k as default}; diff --git a/assets/projects_citadel_index.md.107fdf79.lean.js b/assets/projects_citadel_index.md.e4de060a.lean.js similarity index 94% rename from assets/projects_citadel_index.md.107fdf79.lean.js rename to assets/projects_citadel_index.md.e4de060a.lean.js index 59872456..e8074ffb 100644 --- a/assets/projects_citadel_index.md.107fdf79.lean.js +++ b/assets/projects_citadel_index.md.e4de060a.lean.js @@ -1 +1 @@ -import{_ as a,o as r,c as s,k as e,a as t}from"./chunks/framework.1169fbc9.js";const n="/assets/screenshot.f2631300.png",C=JSON.parse('{"title":"Capture the Citadel","description":"","frontmatter":{"title":"Capture the Citadel"},"headers":[],"relativePath":"projects/citadel/index.md","filePath":"projects/citadel/index.md","lastUpdated":1701138719000}'),o={name:"projects/citadel/index.md"},i=e("h1",{id:"capture-the-citadel",tabindex:"-1"},[t("Capture the Citadel "),e("a",{class:"header-anchor",href:"#capture-the-citadel","aria-label":'Permalink to "Capture the Citadel"'},"​")],-1),c=e("p",null,"A 3D VR re-envisioning of a Slay the Spire-style game by Anthony Lawn and Grant Barbee for their VR class in college's final project.",-1),l=e("p",null,[t("For more details, visit "),e("a",{href:"https://grantcbarbee.github.io/conquer-the-citadel.html",target:"_blank",rel:"noreferrer"},"Grant's page on the game"),t(".")],-1),d=e("p",null,[e("img",{src:n,alt:"Screenshot"})],-1),h=[i,c,l,d];function p(_,m,u,f,g,x){return r(),s("div",null,h)}const k=a(o,[["render",p]]);export{C as __pageData,k as default}; +import{_ as a,o as r,c as s,k as e,a as t}from"./chunks/framework.1169fbc9.js";const n="/assets/screenshot.f2631300.png",C=JSON.parse('{"title":"Capture the Citadel","description":"","frontmatter":{"title":"Capture the Citadel"},"headers":[],"relativePath":"projects/citadel/index.md","filePath":"projects/citadel/index.md","lastUpdated":1701441563000}'),o={name:"projects/citadel/index.md"},i=e("h1",{id:"capture-the-citadel",tabindex:"-1"},[t("Capture the Citadel "),e("a",{class:"header-anchor",href:"#capture-the-citadel","aria-label":'Permalink to "Capture the Citadel"'},"​")],-1),c=e("p",null,"A 3D VR re-envisioning of a Slay the Spire-style game by Anthony Lawn and Grant Barbee for their VR class in college's final project.",-1),l=e("p",null,[t("For more details, visit "),e("a",{href:"https://grantcbarbee.github.io/conquer-the-citadel.html",target:"_blank",rel:"noreferrer"},"Grant's page on the game"),t(".")],-1),d=e("p",null,[e("img",{src:n,alt:"Screenshot"})],-1),h=[i,c,l,d];function p(_,m,u,f,g,x){return r(),s("div",null,h)}const k=a(o,[["render",p]]);export{C as __pageData,k as default}; diff --git a/assets/projects_dice_index.md.2aa1cd0a.js b/assets/projects_dice_index.md.f3f5673d.js similarity index 99% rename from assets/projects_dice_index.md.2aa1cd0a.js rename to assets/projects_dice_index.md.f3f5673d.js index 81f9556c..7af857ce 100644 --- a/assets/projects_dice_index.md.2aa1cd0a.js +++ b/assets/projects_dice_index.md.f3f5673d.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as i}from"./chunks/framework.1169fbc9.js";const o="/assets/da2.57c7af0b.png",s="/assets/editors.c2eaa93b.png",n="/assets/simulator.7ede7b83.jpg",r="/assets/da1.ae7a2bb1.png",h="/assets/da6.5b5d63de.png",d="/assets/da7.b7b33663.png",l="/assets/da8.d623c64f.png",c="/assets/da3.e16fb4de.png",p="/assets/da9.35a2db61.png",I=JSON.parse('{"title":"Dice Armor","description":"","frontmatter":{"title":"Dice Armor"},"headers":[],"relativePath":"projects/dice/index.md","filePath":"projects/dice/index.md","lastUpdated":1701138719000}'),m={name:"projects/dice/index.md"},u=i('

Dice Armor ​

Download Here

Dice Armor is a game that started development as a semester-long project by a team of nine: a producer, a creative director, a narrative writer, an artist, two programmers, and 3 game designers. The information here is about my contributions as the lead programmer over the semester because I can show off stuff like the editor scripts I wrote. I was doing everything from interface coding, editor scripts, integrating Babble Buds, and of course, everything related to the gameplay itself. To date I'm still the lead programmer for the game; for more up-to-date information on the current state of the game please visit the official site.

The build available here was created for showing off at the end of the semester, and as such has some buttons present to make the game easier to skip parts of the game to see all the content: You start with all the dice in the game already in the shop, there's a button to give yourself free money to buy these dice with, and in the duel, there are buttons to force a win or a loss, which can be used to skip the tutorial (not recommended for first-time players).

Tutorial

Dice Armor is a dice dueling game. Players can use abilities, flip dice, and attack each other to win in a dice game that puts chance into the hands of the players. This is what the dueling scene looks like, with a tutorial cutscene happening on top to guide the player through the basics. Also, all the dice are constructed dynamically, using quaternion math to figure out the placement of each component relative to the face it is going on. The die in the middle has one of the player' and opponents' portraits on each of its sides.

Editors

For many of the objects I've created, I've made scriptable objects so that game designers can add and modify them easily. Additionally, I would create custom inspectors for the objects to help make them as easy to understand and edit as possible. The opponent's artificial intelligence is made up of many strategies, in a prioritized list. When it is the opponents' turn they go through each strategy and check if they can be run, and if so then the opponent performs the strategy and starts back over at the top of the list of strategies. The + sign under the list of strategies opens an organized dropdown of all the various strategies.

Simulator

In addition to custom inspector code, I've created new tools for the editor for our game designers to use. This is a duel simulator that will take two opponents and simulate an arbitrary number of duels between them, and output the results and summarize them for you, much much quicker than manually going through the duels, even with an absurdly high timeScale. This will become incredibly useful in making balance changes and testing new dice against existing sets. This is a screenshot of it in edit mode, but in play mode it removes the "Dueling Managers" field and will use whatever the current duel balance settings are, allowing for the GDs to test freely in play mode without worrying about undoing all their changes afterward.

Cutscene

I created the Babble Buds puppet editor and ported the rendering library I wrote for it to C# so it could be used in Unity. Dice Armor has a full campaign using cutscenes made using the Babble Buds cutscene editor, taking advantage of its support for custom commands and fields to control things like talking, giving the player dice and money, starting duels, and controlling player progression through the story.

Action Wheel

When a cutscene ends, its final command is to either start a duel or set the next cutscene in the story. In the latter case, there is an additional field for what to call the next cutscene, and what location it takes place. The cutscene is then added to the player's save file, and when they visit the city locations are greyed out until they have at least one action to do there. Each location has a dynamically populated action wheel with a custom range of acceptable angles.

Shop

The dice shop is dynamically populated by a list of dice available to the player, which can be changed during cutscenes, and is checked against the dice owned by the player to generate sold-out indicators. On the left, the player can choose to filter the options down to a single dice effect, which also updates the "Buy All" button to buy only all the dice in the current filter.

Inventory

The inventory works most the same as the shop, but for equipping dice. It also allows you to drag individual dice or entire sets to the equipped dice glyph. While dragging it will highlight all the slots the new dice will be equipped into.

Dice Rolling

The dice rolling uses the physics engine and detects once the dice have stopped moving, then determines which side is face up based on which of the normals is closest to straight up. It flags the die as cocked if that smallest angle is above a threshold. The dice sink into the table when not rolling to not interfere with any dice that are rolling.

Missile Storm

During certain events like winning the game or having the face of a die broken, the players' portraits will flash an emotion for a second. After winning, a random living die from the winning player is chosen to play their "finisher move", a flashy and dramatic effect to end the game. Shown is the arcane mechana's finisher, "Missile Storm".

',22),g=[u];function f(y,b,w,_,v,k){return t(),a("div",null,g)}const q=e(m,[["render",f]]);export{I as __pageData,q as default}; +import{_ as e,o as t,c as a,Q as i}from"./chunks/framework.1169fbc9.js";const o="/assets/da2.57c7af0b.png",s="/assets/editors.c2eaa93b.png",n="/assets/simulator.7ede7b83.jpg",r="/assets/da1.ae7a2bb1.png",h="/assets/da6.5b5d63de.png",d="/assets/da7.b7b33663.png",l="/assets/da8.d623c64f.png",c="/assets/da3.e16fb4de.png",p="/assets/da9.35a2db61.png",I=JSON.parse('{"title":"Dice Armor","description":"","frontmatter":{"title":"Dice Armor"},"headers":[],"relativePath":"projects/dice/index.md","filePath":"projects/dice/index.md","lastUpdated":1701441563000}'),m={name:"projects/dice/index.md"},u=i('

Dice Armor ​

Download Here

Dice Armor is a game that started development as a semester-long project by a team of nine: a producer, a creative director, a narrative writer, an artist, two programmers, and 3 game designers. The information here is about my contributions as the lead programmer over the semester because I can show off stuff like the editor scripts I wrote. I was doing everything from interface coding, editor scripts, integrating Babble Buds, and of course, everything related to the gameplay itself. To date I'm still the lead programmer for the game; for more up-to-date information on the current state of the game please visit the official site.

The build available here was created for showing off at the end of the semester, and as such has some buttons present to make the game easier to skip parts of the game to see all the content: You start with all the dice in the game already in the shop, there's a button to give yourself free money to buy these dice with, and in the duel, there are buttons to force a win or a loss, which can be used to skip the tutorial (not recommended for first-time players).

Tutorial

Dice Armor is a dice dueling game. Players can use abilities, flip dice, and attack each other to win in a dice game that puts chance into the hands of the players. This is what the dueling scene looks like, with a tutorial cutscene happening on top to guide the player through the basics. Also, all the dice are constructed dynamically, using quaternion math to figure out the placement of each component relative to the face it is going on. The die in the middle has one of the player' and opponents' portraits on each of its sides.

Editors

For many of the objects I've created, I've made scriptable objects so that game designers can add and modify them easily. Additionally, I would create custom inspectors for the objects to help make them as easy to understand and edit as possible. The opponent's artificial intelligence is made up of many strategies, in a prioritized list. When it is the opponents' turn they go through each strategy and check if they can be run, and if so then the opponent performs the strategy and starts back over at the top of the list of strategies. The + sign under the list of strategies opens an organized dropdown of all the various strategies.

Simulator

In addition to custom inspector code, I've created new tools for the editor for our game designers to use. This is a duel simulator that will take two opponents and simulate an arbitrary number of duels between them, and output the results and summarize them for you, much much quicker than manually going through the duels, even with an absurdly high timeScale. This will become incredibly useful in making balance changes and testing new dice against existing sets. This is a screenshot of it in edit mode, but in play mode it removes the "Dueling Managers" field and will use whatever the current duel balance settings are, allowing for the GDs to test freely in play mode without worrying about undoing all their changes afterward.

Cutscene

I created the Babble Buds puppet editor and ported the rendering library I wrote for it to C# so it could be used in Unity. Dice Armor has a full campaign using cutscenes made using the Babble Buds cutscene editor, taking advantage of its support for custom commands and fields to control things like talking, giving the player dice and money, starting duels, and controlling player progression through the story.

Action Wheel

When a cutscene ends, its final command is to either start a duel or set the next cutscene in the story. In the latter case, there is an additional field for what to call the next cutscene, and what location it takes place. The cutscene is then added to the player's save file, and when they visit the city locations are greyed out until they have at least one action to do there. Each location has a dynamically populated action wheel with a custom range of acceptable angles.

Shop

The dice shop is dynamically populated by a list of dice available to the player, which can be changed during cutscenes, and is checked against the dice owned by the player to generate sold-out indicators. On the left, the player can choose to filter the options down to a single dice effect, which also updates the "Buy All" button to buy only all the dice in the current filter.

Inventory

The inventory works most the same as the shop, but for equipping dice. It also allows you to drag individual dice or entire sets to the equipped dice glyph. While dragging it will highlight all the slots the new dice will be equipped into.

Dice Rolling

The dice rolling uses the physics engine and detects once the dice have stopped moving, then determines which side is face up based on which of the normals is closest to straight up. It flags the die as cocked if that smallest angle is above a threshold. The dice sink into the table when not rolling to not interfere with any dice that are rolling.

Missile Storm

During certain events like winning the game or having the face of a die broken, the players' portraits will flash an emotion for a second. After winning, a random living die from the winning player is chosen to play their "finisher move", a flashy and dramatic effect to end the game. Shown is the arcane mechana's finisher, "Missile Storm".

',22),g=[u];function f(y,b,w,_,v,k){return t(),a("div",null,g)}const q=e(m,[["render",f]]);export{I as __pageData,q as default}; diff --git a/assets/projects_dice_index.md.2aa1cd0a.lean.js b/assets/projects_dice_index.md.f3f5673d.lean.js similarity index 91% rename from assets/projects_dice_index.md.2aa1cd0a.lean.js rename to assets/projects_dice_index.md.f3f5673d.lean.js index 01d62523..7f348c5b 100644 --- a/assets/projects_dice_index.md.2aa1cd0a.lean.js +++ b/assets/projects_dice_index.md.f3f5673d.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as i}from"./chunks/framework.1169fbc9.js";const o="/assets/da2.57c7af0b.png",s="/assets/editors.c2eaa93b.png",n="/assets/simulator.7ede7b83.jpg",r="/assets/da1.ae7a2bb1.png",h="/assets/da6.5b5d63de.png",d="/assets/da7.b7b33663.png",l="/assets/da8.d623c64f.png",c="/assets/da3.e16fb4de.png",p="/assets/da9.35a2db61.png",I=JSON.parse('{"title":"Dice Armor","description":"","frontmatter":{"title":"Dice Armor"},"headers":[],"relativePath":"projects/dice/index.md","filePath":"projects/dice/index.md","lastUpdated":1701138719000}'),m={name:"projects/dice/index.md"},u=i("",22),g=[u];function f(y,b,w,_,v,k){return t(),a("div",null,g)}const q=e(m,[["render",f]]);export{I as __pageData,q as default}; +import{_ as e,o as t,c as a,Q as i}from"./chunks/framework.1169fbc9.js";const o="/assets/da2.57c7af0b.png",s="/assets/editors.c2eaa93b.png",n="/assets/simulator.7ede7b83.jpg",r="/assets/da1.ae7a2bb1.png",h="/assets/da6.5b5d63de.png",d="/assets/da7.b7b33663.png",l="/assets/da8.d623c64f.png",c="/assets/da3.e16fb4de.png",p="/assets/da9.35a2db61.png",I=JSON.parse('{"title":"Dice Armor","description":"","frontmatter":{"title":"Dice Armor"},"headers":[],"relativePath":"projects/dice/index.md","filePath":"projects/dice/index.md","lastUpdated":1701441563000}'),m={name:"projects/dice/index.md"},u=i("",22),g=[u];function f(y,b,w,_,v,k){return t(),a("div",null,g)}const q=e(m,[["render",f]]);export{I as __pageData,q as default}; diff --git a/assets/projects_index.md.39a54339.js b/assets/projects_index.md.575a26a1.js similarity index 91% rename from assets/projects_index.md.39a54339.js rename to assets/projects_index.md.575a26a1.js index 79b48370..51f58d9c 100644 --- a/assets/projects_index.md.39a54339.js +++ b/assets/projects_index.md.575a26a1.js @@ -1 +1 @@ -import{_ as a,o as t,c as o,k as e,a as s}from"./chunks/framework.1169fbc9.js";const u=JSON.parse('{"title":"Projects","description":"","frontmatter":{"title":"Projects","lastUpdated":false},"headers":[],"relativePath":"projects/index.md","filePath":"projects/index.md","lastUpdated":1701138719000}'),d={name:"projects/index.md"},n=e("h1",{id:"games-and-tools",tabindex:"-1"},[s("Games and Tools "),e("a",{class:"header-anchor",href:"#games-and-tools","aria-label":'Permalink to "Games and Tools"'},"​")],-1),r=e("p",null,"Check out the various games and tools I've made or worked on in the sidebar!",-1),c=[n,r];function i(l,p,_,m,h,f){return t(),o("div",null,c)}const k=a(d,[["render",i]]);export{u as __pageData,k as default}; +import{_ as a,o as t,c as o,k as e,a as s}from"./chunks/framework.1169fbc9.js";const u=JSON.parse('{"title":"Projects","description":"","frontmatter":{"title":"Projects","lastUpdated":false},"headers":[],"relativePath":"projects/index.md","filePath":"projects/index.md","lastUpdated":1701441563000}'),d={name:"projects/index.md"},n=e("h1",{id:"games-and-tools",tabindex:"-1"},[s("Games and Tools "),e("a",{class:"header-anchor",href:"#games-and-tools","aria-label":'Permalink to "Games and Tools"'},"​")],-1),r=e("p",null,"Check out the various games and tools I've made or worked on in the sidebar!",-1),c=[n,r];function i(l,p,_,m,h,f){return t(),o("div",null,c)}const k=a(d,[["render",i]]);export{u as __pageData,k as default}; diff --git a/assets/projects_index.md.39a54339.lean.js b/assets/projects_index.md.575a26a1.lean.js similarity index 91% rename from assets/projects_index.md.39a54339.lean.js rename to assets/projects_index.md.575a26a1.lean.js index 79b48370..51f58d9c 100644 --- a/assets/projects_index.md.39a54339.lean.js +++ b/assets/projects_index.md.575a26a1.lean.js @@ -1 +1 @@ -import{_ as a,o as t,c as o,k as e,a as s}from"./chunks/framework.1169fbc9.js";const u=JSON.parse('{"title":"Projects","description":"","frontmatter":{"title":"Projects","lastUpdated":false},"headers":[],"relativePath":"projects/index.md","filePath":"projects/index.md","lastUpdated":1701138719000}'),d={name:"projects/index.md"},n=e("h1",{id:"games-and-tools",tabindex:"-1"},[s("Games and Tools "),e("a",{class:"header-anchor",href:"#games-and-tools","aria-label":'Permalink to "Games and Tools"'},"​")],-1),r=e("p",null,"Check out the various games and tools I've made or worked on in the sidebar!",-1),c=[n,r];function i(l,p,_,m,h,f){return t(),o("div",null,c)}const k=a(d,[["render",i]]);export{u as __pageData,k as default}; +import{_ as a,o as t,c as o,k as e,a as s}from"./chunks/framework.1169fbc9.js";const u=JSON.parse('{"title":"Projects","description":"","frontmatter":{"title":"Projects","lastUpdated":false},"headers":[],"relativePath":"projects/index.md","filePath":"projects/index.md","lastUpdated":1701441563000}'),d={name:"projects/index.md"},n=e("h1",{id:"games-and-tools",tabindex:"-1"},[s("Games and Tools "),e("a",{class:"header-anchor",href:"#games-and-tools","aria-label":'Permalink to "Games and Tools"'},"​")],-1),r=e("p",null,"Check out the various games and tools I've made or worked on in the sidebar!",-1),c=[n,r];function i(l,p,_,m,h,f){return t(),o("div",null,c)}const k=a(d,[["render",i]]);export{u as __pageData,k as default}; diff --git a/assets/projects_optispeech_index.md.79247f34.js b/assets/projects_optispeech_index.md.8eeb4f1d.js similarity index 97% rename from assets/projects_optispeech_index.md.79247f34.js rename to assets/projects_optispeech_index.md.8eeb4f1d.js index 1454fde7..4459f6ab 100644 --- a/assets/projects_optispeech_index.md.79247f34.js +++ b/assets/projects_optispeech_index.md.8eeb4f1d.js @@ -1 +1 @@ -import{_ as t,o as s,c as a,k as e,a as o}from"./chunks/framework.1169fbc9.js";const n="/assets/system-architecture-600.254c8a7e.jpg",i="/assets/new-interface.99f03ba7.png",r="/assets/documentation.4e9ae6e0.png",c="/assets/unittests.e8833eb5.png",U=JSON.parse('{"title":"OptiSpeech","description":"","frontmatter":{"title":"OptiSpeech"},"headers":[],"relativePath":"projects/optispeech/index.md","filePath":"projects/optispeech/index.md","lastUpdated":1701138719000}'),l={name:"projects/optispeech/index.md"},p=e("h1",{id:"optispeech",tabindex:"-1"},[o("OptiSpeech "),e("a",{class:"header-anchor",href:"#optispeech","aria-label":'Permalink to "OptiSpeech"'},"​")],-1),d=e("p",null,"The Optispeech project involves designing and testing a real-time tongue model that can be viewed in a transparent head while a subject talks — for the purposes of treating speech errors and teaching foreign language sounds. This work has been conducted in partnership with Vulintus and with support from the National Institutes of Health (NIH). The UT Dallas Speech Production Lab is currently updating the program to use updated versions of Unity and adding support for more features and hardware.",-1),h=e("p",null,[e("img",{src:n,alt:"System Architecture"})],-1),u=e("iframe",{width:"560",height:"315",src:"https://www.youtube.com/embed/9uHqIRs7ZjM",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:"",style:{display:"block",margin:"auto"}},null,-1),m=e("p",null,"This video shows a talker with WAVE sensors placed on the tongue hitting a virtual target sphere located at the alveolar ridge. When an alveolar consonant is hit (e.g., /s/, /n/, /d/) the sphere changes color from red to green.",-1),g=e("iframe",{width:"560",height:"315",src:"https://www.youtube.com/embed/Oz42mKvlzqI",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:"",style:{display:"block",margin:"auto"}},null,-1),_=e("p",null,"This video shows an American talker learning a novel sound not found in English. When the post-alveolar consonant is hit, the target sphere changes color from red to green. Here, the NDI WAVE system serves as input.",-1),f=e("p",null,"The program is being updated by a team in the UT Dallas Speech Production Lab led by Anthony Lawn, so the program uses a more modern version of Unity, has an easier-to-use interface, can more easily support new features, and can connect to additional EMA systems, namely the Carstens AG501.",-1),w=e("p",null,[e("img",{src:i,alt:"New Interface"})],-1),y=e("p",null,"In addition, the program now includes documentation and unit tests to improve program stability and maintainability going forward.",-1),b=e("p",null,[e("img",{src:r,alt:"Documentation"})],-1),v=e("p",null,[e("img",{src:c,alt:"Unit Tests"})],-1),k=[p,d,h,u,m,g,_,f,w,y,b,v];function T(x,S,j,A,I,N){return s(),a("div",null,k)}const D=t(l,[["render",T]]);export{U as __pageData,D as default}; +import{_ as t,o as s,c as a,k as e,a as o}from"./chunks/framework.1169fbc9.js";const n="/assets/system-architecture-600.254c8a7e.jpg",i="/assets/new-interface.99f03ba7.png",r="/assets/documentation.4e9ae6e0.png",c="/assets/unittests.e8833eb5.png",U=JSON.parse('{"title":"OptiSpeech","description":"","frontmatter":{"title":"OptiSpeech"},"headers":[],"relativePath":"projects/optispeech/index.md","filePath":"projects/optispeech/index.md","lastUpdated":1701441563000}'),l={name:"projects/optispeech/index.md"},p=e("h1",{id:"optispeech",tabindex:"-1"},[o("OptiSpeech "),e("a",{class:"header-anchor",href:"#optispeech","aria-label":'Permalink to "OptiSpeech"'},"​")],-1),d=e("p",null,"The Optispeech project involves designing and testing a real-time tongue model that can be viewed in a transparent head while a subject talks — for the purposes of treating speech errors and teaching foreign language sounds. This work has been conducted in partnership with Vulintus and with support from the National Institutes of Health (NIH). The UT Dallas Speech Production Lab is currently updating the program to use updated versions of Unity and adding support for more features and hardware.",-1),h=e("p",null,[e("img",{src:n,alt:"System Architecture"})],-1),u=e("iframe",{width:"560",height:"315",src:"https://www.youtube.com/embed/9uHqIRs7ZjM",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:"",style:{display:"block",margin:"auto"}},null,-1),m=e("p",null,"This video shows a talker with WAVE sensors placed on the tongue hitting a virtual target sphere located at the alveolar ridge. When an alveolar consonant is hit (e.g., /s/, /n/, /d/) the sphere changes color from red to green.",-1),g=e("iframe",{width:"560",height:"315",src:"https://www.youtube.com/embed/Oz42mKvlzqI",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:"",style:{display:"block",margin:"auto"}},null,-1),_=e("p",null,"This video shows an American talker learning a novel sound not found in English. When the post-alveolar consonant is hit, the target sphere changes color from red to green. Here, the NDI WAVE system serves as input.",-1),f=e("p",null,"The program is being updated by a team in the UT Dallas Speech Production Lab led by Anthony Lawn, so the program uses a more modern version of Unity, has an easier-to-use interface, can more easily support new features, and can connect to additional EMA systems, namely the Carstens AG501.",-1),w=e("p",null,[e("img",{src:i,alt:"New Interface"})],-1),y=e("p",null,"In addition, the program now includes documentation and unit tests to improve program stability and maintainability going forward.",-1),b=e("p",null,[e("img",{src:r,alt:"Documentation"})],-1),v=e("p",null,[e("img",{src:c,alt:"Unit Tests"})],-1),k=[p,d,h,u,m,g,_,f,w,y,b,v];function T(x,S,j,A,I,N){return s(),a("div",null,k)}const D=t(l,[["render",T]]);export{U as __pageData,D as default}; diff --git a/assets/projects_optispeech_index.md.79247f34.lean.js b/assets/projects_optispeech_index.md.8eeb4f1d.lean.js similarity index 97% rename from assets/projects_optispeech_index.md.79247f34.lean.js rename to assets/projects_optispeech_index.md.8eeb4f1d.lean.js index 1454fde7..4459f6ab 100644 --- a/assets/projects_optispeech_index.md.79247f34.lean.js +++ b/assets/projects_optispeech_index.md.8eeb4f1d.lean.js @@ -1 +1 @@ -import{_ as t,o as s,c as a,k as e,a as o}from"./chunks/framework.1169fbc9.js";const n="/assets/system-architecture-600.254c8a7e.jpg",i="/assets/new-interface.99f03ba7.png",r="/assets/documentation.4e9ae6e0.png",c="/assets/unittests.e8833eb5.png",U=JSON.parse('{"title":"OptiSpeech","description":"","frontmatter":{"title":"OptiSpeech"},"headers":[],"relativePath":"projects/optispeech/index.md","filePath":"projects/optispeech/index.md","lastUpdated":1701138719000}'),l={name:"projects/optispeech/index.md"},p=e("h1",{id:"optispeech",tabindex:"-1"},[o("OptiSpeech "),e("a",{class:"header-anchor",href:"#optispeech","aria-label":'Permalink to "OptiSpeech"'},"​")],-1),d=e("p",null,"The Optispeech project involves designing and testing a real-time tongue model that can be viewed in a transparent head while a subject talks — for the purposes of treating speech errors and teaching foreign language sounds. This work has been conducted in partnership with Vulintus and with support from the National Institutes of Health (NIH). The UT Dallas Speech Production Lab is currently updating the program to use updated versions of Unity and adding support for more features and hardware.",-1),h=e("p",null,[e("img",{src:n,alt:"System Architecture"})],-1),u=e("iframe",{width:"560",height:"315",src:"https://www.youtube.com/embed/9uHqIRs7ZjM",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:"",style:{display:"block",margin:"auto"}},null,-1),m=e("p",null,"This video shows a talker with WAVE sensors placed on the tongue hitting a virtual target sphere located at the alveolar ridge. When an alveolar consonant is hit (e.g., /s/, /n/, /d/) the sphere changes color from red to green.",-1),g=e("iframe",{width:"560",height:"315",src:"https://www.youtube.com/embed/Oz42mKvlzqI",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:"",style:{display:"block",margin:"auto"}},null,-1),_=e("p",null,"This video shows an American talker learning a novel sound not found in English. When the post-alveolar consonant is hit, the target sphere changes color from red to green. Here, the NDI WAVE system serves as input.",-1),f=e("p",null,"The program is being updated by a team in the UT Dallas Speech Production Lab led by Anthony Lawn, so the program uses a more modern version of Unity, has an easier-to-use interface, can more easily support new features, and can connect to additional EMA systems, namely the Carstens AG501.",-1),w=e("p",null,[e("img",{src:i,alt:"New Interface"})],-1),y=e("p",null,"In addition, the program now includes documentation and unit tests to improve program stability and maintainability going forward.",-1),b=e("p",null,[e("img",{src:r,alt:"Documentation"})],-1),v=e("p",null,[e("img",{src:c,alt:"Unit Tests"})],-1),k=[p,d,h,u,m,g,_,f,w,y,b,v];function T(x,S,j,A,I,N){return s(),a("div",null,k)}const D=t(l,[["render",T]]);export{U as __pageData,D as default}; +import{_ as t,o as s,c as a,k as e,a as o}from"./chunks/framework.1169fbc9.js";const n="/assets/system-architecture-600.254c8a7e.jpg",i="/assets/new-interface.99f03ba7.png",r="/assets/documentation.4e9ae6e0.png",c="/assets/unittests.e8833eb5.png",U=JSON.parse('{"title":"OptiSpeech","description":"","frontmatter":{"title":"OptiSpeech"},"headers":[],"relativePath":"projects/optispeech/index.md","filePath":"projects/optispeech/index.md","lastUpdated":1701441563000}'),l={name:"projects/optispeech/index.md"},p=e("h1",{id:"optispeech",tabindex:"-1"},[o("OptiSpeech "),e("a",{class:"header-anchor",href:"#optispeech","aria-label":'Permalink to "OptiSpeech"'},"​")],-1),d=e("p",null,"The Optispeech project involves designing and testing a real-time tongue model that can be viewed in a transparent head while a subject talks — for the purposes of treating speech errors and teaching foreign language sounds. This work has been conducted in partnership with Vulintus and with support from the National Institutes of Health (NIH). The UT Dallas Speech Production Lab is currently updating the program to use updated versions of Unity and adding support for more features and hardware.",-1),h=e("p",null,[e("img",{src:n,alt:"System Architecture"})],-1),u=e("iframe",{width:"560",height:"315",src:"https://www.youtube.com/embed/9uHqIRs7ZjM",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:"",style:{display:"block",margin:"auto"}},null,-1),m=e("p",null,"This video shows a talker with WAVE sensors placed on the tongue hitting a virtual target sphere located at the alveolar ridge. When an alveolar consonant is hit (e.g., /s/, /n/, /d/) the sphere changes color from red to green.",-1),g=e("iframe",{width:"560",height:"315",src:"https://www.youtube.com/embed/Oz42mKvlzqI",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",allowfullscreen:"",style:{display:"block",margin:"auto"}},null,-1),_=e("p",null,"This video shows an American talker learning a novel sound not found in English. When the post-alveolar consonant is hit, the target sphere changes color from red to green. Here, the NDI WAVE system serves as input.",-1),f=e("p",null,"The program is being updated by a team in the UT Dallas Speech Production Lab led by Anthony Lawn, so the program uses a more modern version of Unity, has an easier-to-use interface, can more easily support new features, and can connect to additional EMA systems, namely the Carstens AG501.",-1),w=e("p",null,[e("img",{src:i,alt:"New Interface"})],-1),y=e("p",null,"In addition, the program now includes documentation and unit tests to improve program stability and maintainability going forward.",-1),b=e("p",null,[e("img",{src:r,alt:"Documentation"})],-1),v=e("p",null,[e("img",{src:c,alt:"Unit Tests"})],-1),k=[p,d,h,u,m,g,_,f,w,y,b,v];function T(x,S,j,A,I,N){return s(),a("div",null,k)}const D=t(l,[["render",T]]);export{U as __pageData,D as default}; diff --git a/assets/projects_vecs_index.md.cfb70a46.js b/assets/projects_vecs_index.md.2f7e22a7.js similarity index 96% rename from assets/projects_vecs_index.md.cfb70a46.js rename to assets/projects_vecs_index.md.2f7e22a7.js index 6f3f7b69..f3d5fe94 100644 --- a/assets/projects_vecs_index.md.cfb70a46.js +++ b/assets/projects_vecs_index.md.2f7e22a7.js @@ -1 +1 @@ -import{_ as e,o as t,c as s,Q as a}from"./chunks/framework.1169fbc9.js";const o="/assets/screenshot.78830a30.png",n="/assets/debug.0a8c47b7.png",r="/assets/sandsoftime.ba63f865.png",w=JSON.parse('{"title":"V-ecs","description":"","frontmatter":{"title":"V-ecs"},"headers":[],"relativePath":"projects/vecs/index.md","filePath":"projects/vecs/index.md","lastUpdated":1701138719000}'),i={name:"projects/vecs/index.md"},l=a('

V-ecs ​

V-ecs Screenshot

V-ecs (pronounced "Vex") is a Vulkan-based engine I made for making highly moddable games and tools in Lua centered around the ECS design pattern and a work-stealing job system.

The engine works with "worlds", which are collections of systems and renderers. The engine comes with several worlds using systems and renderers I made, including a voxel world, an incremental game, and some test scenes. All of these include systems to render the fps as well as show a debug console by typing the grave key (`). The default world is a title screen that detects any worlds in the "worlds" folder and displays a button for each of them.

Debug Menu

The original plans were to eventually put it on the steam workshop so people could more easily share their creations amongst each other, but I never became happy enough with the performance of the engine - the parallelization of the lua code involved a lot of overhead that severely limited performance.

Instead, I made a couple of worlds by myself - an infinite procedurally generated voxel world, a simple incremental game, and a more complex incremental game I call "Sands of Time".

Sands of Time

',8),c=[l];function d(p,m,h,u,_,g){return t(),s("div",null,c)}const v=e(i,[["render",d]]);export{w as __pageData,v as default}; +import{_ as e,o as t,c as s,Q as a}from"./chunks/framework.1169fbc9.js";const o="/assets/screenshot.78830a30.png",n="/assets/debug.0a8c47b7.png",r="/assets/sandsoftime.ba63f865.png",w=JSON.parse('{"title":"V-ecs","description":"","frontmatter":{"title":"V-ecs"},"headers":[],"relativePath":"projects/vecs/index.md","filePath":"projects/vecs/index.md","lastUpdated":1701441563000}'),i={name:"projects/vecs/index.md"},l=a('

V-ecs ​

V-ecs Screenshot

V-ecs (pronounced "Vex") is a Vulkan-based engine I made for making highly moddable games and tools in Lua centered around the ECS design pattern and a work-stealing job system.

The engine works with "worlds", which are collections of systems and renderers. The engine comes with several worlds using systems and renderers I made, including a voxel world, an incremental game, and some test scenes. All of these include systems to render the fps as well as show a debug console by typing the grave key (`). The default world is a title screen that detects any worlds in the "worlds" folder and displays a button for each of them.

Debug Menu

The original plans were to eventually put it on the steam workshop so people could more easily share their creations amongst each other, but I never became happy enough with the performance of the engine - the parallelization of the lua code involved a lot of overhead that severely limited performance.

Instead, I made a couple of worlds by myself - an infinite procedurally generated voxel world, a simple incremental game, and a more complex incremental game I call "Sands of Time".

Sands of Time

',8),c=[l];function d(p,m,h,u,_,g){return t(),s("div",null,c)}const v=e(i,[["render",d]]);export{w as __pageData,v as default}; diff --git a/assets/projects_vecs_index.md.cfb70a46.lean.js b/assets/projects_vecs_index.md.2f7e22a7.lean.js similarity index 88% rename from assets/projects_vecs_index.md.cfb70a46.lean.js rename to assets/projects_vecs_index.md.2f7e22a7.lean.js index 4d293900..0c179ca2 100644 --- a/assets/projects_vecs_index.md.cfb70a46.lean.js +++ b/assets/projects_vecs_index.md.2f7e22a7.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as s,Q as a}from"./chunks/framework.1169fbc9.js";const o="/assets/screenshot.78830a30.png",n="/assets/debug.0a8c47b7.png",r="/assets/sandsoftime.ba63f865.png",w=JSON.parse('{"title":"V-ecs","description":"","frontmatter":{"title":"V-ecs"},"headers":[],"relativePath":"projects/vecs/index.md","filePath":"projects/vecs/index.md","lastUpdated":1701138719000}'),i={name:"projects/vecs/index.md"},l=a("",8),c=[l];function d(p,m,h,u,_,g){return t(),s("div",null,c)}const v=e(i,[["render",d]]);export{w as __pageData,v as default}; +import{_ as e,o as t,c as s,Q as a}from"./chunks/framework.1169fbc9.js";const o="/assets/screenshot.78830a30.png",n="/assets/debug.0a8c47b7.png",r="/assets/sandsoftime.ba63f865.png",w=JSON.parse('{"title":"V-ecs","description":"","frontmatter":{"title":"V-ecs"},"headers":[],"relativePath":"projects/vecs/index.md","filePath":"projects/vecs/index.md","lastUpdated":1701441563000}'),i={name:"projects/vecs/index.md"},l=a("",8),c=[l];function d(p,m,h,u,_,g){return t(),s("div",null,c)}const v=e(i,[["render",d]]);export{w as __pageData,v as default}; diff --git a/guide-to-incrementals/design/criticism/index.html b/guide-to-incrementals/design/criticism/index.html index 137c3c4b..5efd788f 100644 --- a/guide-to-incrementals/design/criticism/index.html +++ b/guide-to-incrementals/design/criticism/index.html @@ -26,7 +26,7 @@

Appearance

Navigating Criticism ​

Developing games is fun and exciting and teaches a lot of wonderful skills - I enthusiastically encourage anyone with an interest in game development to try it out - and incremental games are a wonderful way to get started. However, there are many challenges young and inexperienced developers have to face, and I think the hardest one - harder than coding, debugging, balancing, etc. - is handling criticism. When you put your heart and soul into a game it is natural to feel very vulnerable. While I think there's a lot communities can do to ensure they're welcoming, positive and constructive with their criticisms, inevitably you will eventually read some, and potentially a lot, of comments that can deeply affect you. No one is immune to this, from young incremental game developers to the largest content creators you can think of. That's why it's important to be able to process and navigate criticism, because ultimately collecting feedback is essential to the journey to becoming a better developer. On this page, we'll explore how to embrace criticism, grow from it, and continue to post your games publicly with confidence.

Reading Feedback ​

Game development is a skill that takes time and practice to get truly great at. Criticism and other constructive feedback are vital to continually improving. It's useful to look at the criticism as solely a tool for improving this game and future games - that is to say, it should never be used against you as a person. Insults towards the developer(s) themselves are never okay and should not be allowed within whatever community you're sharing your works in. If you do come across a comment you interpret as an attack upon your person, you should report it. For other negative comments, try not to internalize them; instead, focus on improving the game. By distancing your own identity from your work emotionally, you can better analyze the game and use the feedback to your advantage.

Not all feedback is made equal, and you don't need to feel compelled to read and obey every piece of feedback you receive. Learn to distinguish between constructive feedback and unhelpful comments. Constructive feedback typically offers specific suggestions for improvement, while unhelpful comments are often vague or hurtful. Prioritize the former and disregard the latter. That said, most feedback you get will not be from game developers, so take specific suggestions with a grain of salt. Determine the actual problem they're experiencing, and design what you believe the best solution to that problem would be, regardless if that's the specific solution the player asked for. And keep in mind, due to different player preferences you'll never satisfy everyone, and you don't need to. Ultimately if even just you find the game fun, then that's a success.

Seeking Feedback ​

When deciding where to share your game, consider the type of players you anticipate getting, and the kind of feedback you can anticipate receiving. Different communities will have different levels of support for learning developers, and certain communities may prefer certain types of games or mechanics. It's important to get a diverse set of feedback focused on players you think will enjoy the specific game you're making.

Collecting feedback from other game developers is incredibly helpful. They've trained themselves to recognize good and bad game design and how to articulate the differences, and from my experience are much more likely to leave positive and constructive comments since they've been in your shoes before! They understand the struggles and can offer guidance and emotional support.

Responding to Feedback ​

Negative feedback can naturally feel like an attack, and it's okay to get angry. However, lashing back is never the appropriate response. It's best to cool off IRL, and keep in mind all the positive comments you've received. There's a concept in Psychology called negative bias that explains how negative feedback tends to stick with us much more prominently than positive feedback, so it's useful to regularly remind yourself of all the positive feedback you've received. Celebrate your successes, no matter how small they may seem - getting a game to a state you can publicly share it with people is an accomplishment in and of itself!

Remember your passion and your initial reasons for getting into game development. The journey will have its ups and downs, but staying true to your vision and passion will keep you motivated.

- + \ No newline at end of file diff --git a/guide-to-incrementals/design/introduction/index.html b/guide-to-incrementals/design/introduction/index.html index 5fa91011..5a9bcfff 100644 --- a/guide-to-incrementals/design/introduction/index.html +++ b/guide-to-incrementals/design/introduction/index.html @@ -26,7 +26,7 @@

Appearance

Making an Incremental Game ​

- + \ No newline at end of file diff --git a/guide-to-incrementals/index.html b/guide-to-incrementals/index.html index 297d133f..c2b622a2 100644 --- a/guide-to-incrementals/index.html +++ b/guide-to-incrementals/index.html @@ -26,7 +26,7 @@

Appearance

Introduction ​

This is a comprehensive guide to Incremental Games, a genre of video games. It will explore defining the genre, why it's appealing, and how to design and build your own incremental game. Along the way will be interactive examples, snippets from other creators, and relevant material to contextualize everything.

Note: This is an incomplete document. I want to keep adding opinions and opposing views from other incremental games developers, and add interactive examples to illustrate various points regarding game design and balancing. Consider this a living document - and see the changelog at the end.

Who am I? ​

That's a good question! What authority do I have to be making this site? I haven't made the best incremental games, nor the most incremental games, certainly not the most popular ones either. I do have some formal education in game development, know a lot of incremental game devs, as well as other game devs, and an interest in ludology, classifying genres, etc. I've also made a couple of incremental games myself.

If you have any additional questions about my credentials or anything on this site, feel free to contact me: I'm "The Paper Pilot" on most social media. You'll probably get a response fastest via my discord server, or if you just want to suggest changes to the website you can click the "Edit this page" link present on every single page.

- + \ No newline at end of file diff --git a/guide-to-incrementals/ludology/appeal-developers/index.html b/guide-to-incrementals/ludology/appeal-developers/index.html index bcb10db9..28b774b7 100644 --- a/guide-to-incrementals/ludology/appeal-developers/index.html +++ b/guide-to-incrementals/ludology/appeal-developers/index.html @@ -26,7 +26,7 @@

Appearance

Appeal to Developers ​

There are a lot of developers in the incremental games community - the genre seems to draw them in, and convert a lot of players into developers. Let's explore the reasons why this genre appeals to developers.

Incrementals are Easy to Make ​

Compared to other genres, incrementals have quite low expectations. You don't need to make fancy art, or music, or lay things out nicely. If you can make a button and learn the few lines of code necessary to make a number go up, you can make an incremental. This low threshold makes the genre perfect for those who are actively learning to code and haven't developed any gamedev-related skills yet.

Additionally, unlike other genres incrementals are uniquely easy to implement in a normal web page - no need to worry about rendering sprites, moving them around, implementing physics, etc. New developers can just use HTML to add a button, and the game is now available in your browser. You don't need to choose an engine, have admin privileges, or hell for the dedicated you don't even need a computer - there are tools for web development that run in the browser itself, so you can technically use your phone if that's all you have.

Javascript is a perfectly viable language for making web games, whereas other genres are typically going to require using other more difficult languages to learn. There are countless javascript tutorials that start from 0 knowledge of programming, making it incredibly accessible to beginners.

Players are Easy to Find ​

Once you've finished your game and uploaded it on github pages or itch or just copied the link if you're using glitch or replit (all of which are easy to do), anyone can now play the game in their browser. This low barrier to entry has shown tremendous success in getting completely unknown developers to have thousands of plays.

The incremental games community, which mostly centers around r/incremental_games, is always looking for new games and tends to flood any new ones posted with initial players.

Having your games be played can be incredibly motivating, and the community makes it quite clear that you can expect players to play your game. These communities - both for incremental games in general as well as game-specific communities - tend to be very developer friendly as well. A lot of the developers know each other, and welcome new developers with open arms, often with dedicated channels for programming help and discussions.

Monetization ​

I'd like to clarify that everything I've said above mainly applies to web-based incrementals. Incremental games are also incredibly popular on mobile, but with a much different culture and community. Many mobile gamers will still participate in the web-focused community for the culture. This web-focused community has a culture that has been criticized for being "anti-monetization". Ads, IAPs, and similar forms of monetization are often criticized, mainly due to the abundance of completely non-monetized games available from hobbyist developers. There are exceptions, like paid games often being considered fine, like Increlution or Stuck in Time, or donation ware games like kittens game, but even popular games that have IAP see some level of regular criticism, like NGU Idle, Idle Skilling, or Idle Pins. A large part of this can be explained by the community being hyper-aware of the addictive nature of this genre and its susceptibility to exploiting players.

On mobile, however, monetization is the norm and expected. If an incremental game is available on mobile, it almost certainly will be monetized, and mobile players are aware and accepting of that. Mobile incremental games, due to their addictive nature, tend to make a lot of money. It's very lucrative, and therefore these games are quite abundant on mobile storefronts.

- + \ No newline at end of file diff --git a/guide-to-incrementals/ludology/appeal-gamers/index.html b/guide-to-incrementals/ludology/appeal-gamers/index.html index 9362ec5b..88b22965 100644 --- a/guide-to-incrementals/ludology/appeal-gamers/index.html +++ b/guide-to-incrementals/ludology/appeal-gamers/index.html @@ -26,7 +26,7 @@

Appearance

Appeal to Players ​

This is something that has been discussed and analyzed by many people, and to some extent, I feel like everything that can be said on the topic already has. However, a lot of these analyses are from the perspective of those with not as much experience and involvement within the genre as I'd argue would be necessary for a fully contextualized answer. I recently watched a video about Vampire Survivors, which has since been taken down due to drawing negative attention, which made me think about some interesting arguments about what games are, and what makes them good. The video's argument that "Vampire Survivors is not a video game" mirrors a claim by the developer of Cookie Clicker that his games are "non-games". Using Vampire Survivors and the video made on it as a framework, I'll be answering why incremental games appeal to players. Since the video has been taken down, I'll do my best to contextualize and generalize the arguments of the video without requiring the reader to watch it. For what it's worth, while I disagreed with the video I actually liked a lot of the way it went about thinking about games, and I consider this a continuation of that discussion.

Numbers Going Up ​

This is a very common response to why people enjoy incremental games, although it's not one I find compels me personally, and I suspect it might be a stand-in for progression or content. But reportedly, some people do just like seeing big numbers. I must reiterate I suspect the actual cause is seeing big numbers in context though - if you start at 1e1000 of a currency and get to 1e1001, that isn't going to feel as satisfying as going from 1e10 to 1e100, and in any case, I don't think a button that just adds a zero to your number will feel quite satisfying - I believe its the sense of having made progress, and comparing where you are to where you started and feeling like you've earned your way here that is enjoyable.

Progression ​

Vampire Survivors can be argued to have a comparatively low depth to its combat compared to many other games. I'd argue it has sufficient depth and more than someone might expect who has only played the game for a short while, but it still definitely gets beat out by many other combat-focused games. Instead, a lot of the progression in Vampire Survivors comes from a meta-progression system by which base stats are increased by spending a currency that persists between runs. While it is technically possible to win without this meta-progression system, and indeed in many roguelikes players like to challenge themselves by beating the game without any meta-progression, the criticism can be made that meta-progression de-emphasizes player skill by making it less important to have to beat the game. Certainly, in incremental games, it is often literally impossible to complete a game without taking advantage of the meta-progression systems. I'd argue this does not detract from the game, however, and is actually a part of what makes incremental games, and roguelikes, enjoyable to many players: meta-progression augments the increases in skill the player is naturally gaining as they play. In effect, it's not replacing the skill increase, but exaggerating it to make it feel more real to the player.

Note: There is also a lot of progression from exploring the mechanics and discovering synergies, unlocking new weapons or playable characters, etc. That just isn't as relevant to this discussion, but it does make up a lot of the appeal of the game.

Effortlessness ​

Incremental games are so easy, a lot of them even have you progress while you're not playing! Part of the appeal is being able to feel like you're making progress while doing something actually productive - multitasking, in a way. In this sense, the game is more of a fidget toy - not something to think hard about and play actively, but something to click a few buttons every so often while you're paying attention to a lecture or studying or working. Of course, not all incremental games lend themselves to being played this way - it's specifically "idle" games that work like this. These are games that take an incredibly long amount of time to see all the content, stretching it as thin as possible, but they aren't expecting you to be sitting at your device playing it the entire time. They expect you to leave and come back later to make a bit of progress and repeat the cycle.

If you look at the higher-level play of most games, you'll see them perform difficult feats with ease and speed. They'll achieve a "flow state" that takes all their knowledge and experience of the game and uses it to play the game as instinctively as possible. It's incredible to watch things like Slay the Spire speed runs or competitive DDR-likes. I'd argue the goal of a lot of games with a competitive scene is to get so good that the game becomes effortless. In that sense, a game that allows you to reach that point earlier isn't any less legitimate, but rather lowers the barrier to entry by allowing more people to get "really good" at the game. And to be clear, Vampire Survivors and (most) incremental games aren't trivially easy - they, and to an extent, every game will have some level of learning and improvement over time.

Addiction ​

A lot of these reasons for why incremental games appeal may have reminded you of why gambling appeals to people, particularly those prone to addiction. Indeed, incremental games are quite often criticized for their similarity to a skinner box. Some have gone as far as to say incremental games as a genre are commenting that all games are skinner boxes. The argument goes that some games are not fun, but rather condition players into continuing to play without actually getting anything from the experience. When tied to real-world money this is seen as predatory, and to a lesser extent, even free games may be feeding the addictive sides of people and making them more prone to seek out gambling or micro-transaction heavy games.

While incremental games can be fun and even healthy in certain contexts, they can exacerbate video game addiction more than other genres. If you feel like playing incremental games is taking priority over other things in your life, or manipulating your sleep schedule, it may be prudent to seek help. See r/StopGaming for resources.

Since incremental games are often built on extrinsic motivations in the form of progression systems, it's hard to argue whether players continue to play because they are enjoying the gameplay, or if they are just conditioned to keep doing it because the game keeps rewarding them. Unfortunately, it can often feel like it's the latter, as there isn't typically anything compelling about the "gameplay" of clicking a button and waiting. There may be a significant overlap between those who enjoy incremental games and those who are most prone to addiction, and there are often posts on r/incremental_games about someone either struggling with or overcoming video game addiction.

Strategy ​

Incremental games could be considered a subset of strategy games, and inherit the appeals of strategy games. This includes the appeal of feeling like you've found a good solution to a puzzle, or that you're learning more about the game and are improving at making decisions within it. This applies to Vampire Survivors specifically, where you're learning about evolutions and synergies and what kinds of enemies can spawn under what conditions, and how best to handle them.

Note that strategy games are not all the same difficulty, as well. Vampire Survivors is still easier to play than Starcraft 2, and Cookie Clicker is probably somewhere in between (once you progress sufficiently). Vampire Survivors being so successful may indicate that "easier" strategies may have their separate appeal to harder strategy games - players like to feel smart and that they figured the game out and have optimized or mastered it, and the game being easier doesn't detract from that sense of accomplishment as much as it allows more and more users to be able to reach the point where they gain that sense.

Avoiding Staleness ​

Incremental games tend to have "paradigm shifts", where the gameplay changes in a meaningful way at various times throughout the progression of the game. These upset and change the gameplay loop, which helps keep them from stagnating. This constant "freshness" to the gameplay can keep players engaged for longer, compared to a game with a repetitive and static gameplay loop.

Good Game Design ​

Incremental games tend to show their game design "plainly", so it's more readily apparent if a game has good game design while playing, even if you're not looking for it. While different players have different preferences and might enjoy different types of games more than others, there are underlying good and bad game design principles that players will notice the effects of. To be clear, this isn't talking about stuff like big numbers being enjoyable, where I can comfortably agree to disagree with other players. They don't intrinsically make my experience better, but I'm aware of those for whom it does and I won't argue against their feelings. However, the game designer in me does feel like there are some extremely clear-cut examples of good and bad game design philosophies.

Let's start by giving an example of a mechanic I think can be easily and strongly argued is good game design. There are of course many examples, but a personal favorite of mine is how DOOM encourages aggressive gameplay by linking health drops to melee attacks. It has an intended experience it's trying to give the player - immersing themselves as DOOM guy, who would not hide behind cover when low on health - and this mechanic does a great job at encouraging and effectively teaching players to behave properly. This is in sharp contrast to shooters like Call of Duty, which have you regen health passively, encouraging players to hide behind cover and wait after getting hit. Note that I'm not arguing CoD is poorly designed, as the games have different intended experiences. I'm specifically praising DOOM for having a mechanic that does a good job at ensuring the player has that intended experience.

To contrast with an example I think is bad game design, let's talk about shields in souls-likes. This is a bit of a famous example, and I highly recommend this video essay which spends quite a good bit of time on this topic. Essentially, the argument boils down to players of earlier games in the souls games using shields too much - playing slowly, conservatively, and ultimately having less fun. Players wanted to feel safe, so they ended up playing in a way that ruined the experience for them. The developers solved this by removing shields, apart from an intentionally bad one effectively mocking the playstyle, and it did its job at getting players to play more aggressively, and often have more fun.

To bring the conversation back to incrementals, I'm incredibly opinionated on what makes a good incremental game, which I'll discuss in the game design section. Suffice it to say, incremental games rely more on good game design than other genres, due to not having much to distract from bad game design. This helps (although imperfectly - gamers are a bit too tolerant of bad game design!) well-designed games rise to the top within the genre.

Artistic Merit ​

The Vampire Survivors video made me think back to the old arguments about whether games are art, and whether they ought to be. The video seems preoccupied with attaching value to games solely based on their mechanics and the depth thereof, to the point of arguing Vampire Survivors is a waste of time due to its lack of depth. However, even setting aside the fact that if players are having fun then it's not time wasted, I think games can have artistic merit that supersedes the necessity of having (any / engaging / "deep") gameplay. I think the consensus online is that games are definitively art, although I could see the argument that some genres, like incremental games, might be a bit in a grey area. Let's talk about Vampire Survivors first though - It has a story to tell, with lore and many characters, that drive the player and encourage them to continue exploring the game and discovering things within it. Like any walking simulator, it is no less legitimate of a game or the "art" label because of any lack perceived lack of depth. For what it's worth, most art can be consumed with more ease than VS - any painting, movie, sculpture, etc.

A lot of incrementals have a narrative context that can similarly qualify them as art. Cookie Clicker is, as has been pointed out numerous times before, commenting on excess and increasing production beyond any reasonable limits - devolving into increasing production for its own sake. Indeed, a lot of incremental games are written to comment upon various concepts like capitalism or tropes in games, as discussed when defining Incrementals. However, I'd like to argue most incremental games are still art, even without any narrative context. "Art" as a concept is pretty nebulous already, but I personally like those who define it as an act of expression more than any physical result. The creator and the context within which they created the art, and any meaning they put into it, are all relevant and a part of the art itself. Most incremental games have artistic merit from things like why the creator made it, why they chose to make it an incremental game, and why they made any particular design decision. Hell, even if you play through an entire incremental game without a single thought or feeling, that very fact it elicited nothing can itself be artistic merit!

I'm not an art major, and I may be taking a somewhat extreme take on what is art and what has artistic merit, but I'd argue the overall point stands that games, and incremental games specifically, can have artistic merit, which appeals to many gamers.

- + \ No newline at end of file diff --git a/guide-to-incrementals/ludology/content/index.html b/guide-to-incrementals/ludology/content/index.html index 298ce69a..321efde7 100644 --- a/guide-to-incrementals/ludology/content/index.html +++ b/guide-to-incrementals/ludology/content/index.html @@ -26,7 +26,7 @@

Appearance

What is Content? ​

If you've been in the incremental games community for any amount of time, you'll quickly find the number one thing players want is content. They want as much of it as possible! The most popular incremental games have tons of content, so they just keep stretching on and on and on, introducing mechanic after mechanic, and players love it. In fact, players seem to value the amount of content over the quality of any specific content. However, there's a bit of a lack of understanding concerning what content is, and I'd like to explore what counts as content, and how we measure it. As a baseline definition, I think "content" can just be described as the parts of the game that engage the player, but to truly understand it we need to contextualize what that means and how it affects the gameplay experience.

To clarify the purpose of this page, my goal is not to get (too) nitpicky or to attack games with "low content". There's nothing wrong with short / low-content games - I'm quite a big fan of those games myself! This is mostly targeted toward those who ask for content and settle for "long" games, and those who want to provide content but want to make sure they're not just artificially inflating the game. Ultimately, I suppose the goal is to just reduce the amount of artificially inflated content for the sake of having a "longer" game.

Interaction ​

I think it should be a fairly non-controversial opinion that time spent solely waiting should not count towards content. That is not including the time reading various effects or making decisions in your head, but rather time spent waiting for a condition to be met so you can re-engage with the game.

That is not to say games should necessarily try to minimize this time. Plenty of games lead towards more infrequent interaction and still get popular. In fact, these games appeal to many gamers who want to have something to check up on in between bursts of working on some other activity. These games seem to have fallen slightly out of fashion amongst modern incremental games, but they're still fully valid. The point I'm trying to make here is just that this time is not content. As an extreme example, a game with no interactions and just a counter that goes up every second could safely be said to have 0 content beyond the time it takes to understand what's going on. If it has a list of "goals" to hit, then the time understanding those goals and a short time after achieving each one could be considered content, but not the idle times in between.

Let's take a look at the opposite end of the spectrum - interaction that is so frequent as to become mindless. This is any mechanic where you need to spam-click something to progress. This may be a more controversial take, but I do not believe this constitutes content either. It does not engage the player, because each consecutive click blends together and they do not individually change the gameplay experience. That is to say, a single click and 100 clicks are not meaningfully different in terms of engaging the player. I'd go as far as to say clicking 100 times would be actively worse, as it's artificially delaying the next piece of actual content, alongside the issues of accessibility and potentially causing RSI.

Repeatable Purchases ​

Imagine an entity in a game that you can purchase multiple times, each time it performs the same thing but for a higher cost. These are incredibly common, from the buildings in cookie clicker to the units in swarm sim to the IP and EP multipliers in antimatter dimensions. However, how much content is each specific purchase? Is it content beyond the first purchase? Does it have diminishing returns? What if you are oscillating between two different repeatable purchases? How much content is lost when you automate away a repeatable purchase?

I don't want to take too harsh a stance against repeatable purchases. They're useful tools and can be used in a myriad of interesting ways. I feel they do become "stale" or less meaningful content over time, and this happens exponentially quickly the more frequently it can be purchased. A classic example that I believe goes too far is the IP/EP multipliers in Antimatter Dimensions. I would go as far as to say they are a chore and do not provide any meaningful content after you've bought them a couple of times. It's a method for inflating numbers (effectively making every OOM a 5x step instead of 10x), that punishes the player progression-wise whenever they forget to max it again, and eventually gets automated away as a reward to the player for making enough progress.

Just to voice the other side of this argument, Acamaeda defended the IP multiplier as giving the player a "good" upgrade every OOM. I can understand that to a point and need to clarify I'm mainly criticizing IP/EP multipliers after they've been introduced for a while. In fact, I would defend the multipliers for a short while after they're introduced using the same logic I would use to defend normal dimensions as repeatable purchases, at least pre-infinity. There's "content" to be had in looking at what dimensions will become affordable next, and then choosing which to buy amongst those. The IP/EP multipliers, early into infinity or eternity respectively, provide another option that gets put into that mental queue of things to buy with each OOM reached - although the optimal order is often quite trivial and not particularly engaging.

The IP/EP multipliers are not the only repeatable purchase in antimatter dimensions I take offense to. The time dimensions are also a series of repeatable purchases, that are all so similar and static that it doesn't take long before you never need to put any thought into buying them, how much you're buying at once, or the order you buy them in - you just press max all and move on. The entire tab could've been just the max all button and it would not have made a difference beyond the start of the eternity layer. The normal dimensions technically have this problem as well, but since you're constantly getting antimatter the order feels like it has a larger impact and it's more meaningful content, right up until they're automated away. Infinity dimensions are a compromise between the two, so I'm highlighting time dimensions here as the most egregious.

Following Instructions ​

We're getting more and more controversial as we go along! Let's talk about how linear content is not content now (in some circumstances). A trend in incremental games is adding difficulty by adding a web of effects that abstract the true change you can expect from any specific purchase or decision you make. If a game is both linear and sufficiently abstracts the effect of player decisions, then the player will no longer be engaging with the content - they'll simply be clicking on things as they become available. This isn't necessarily a bad thing, as plenty of players don't mind this style of gameplay, but I'd argue once you reach a point where players don't bother reading the effects, those interactions are no longer truly content. Note that unlike the previous qualifiers mentioned, this qualifier is based on the player, and therefore subjective. In effect, it's a spectrum where the more complicated the web of effects becomes, the more likely it is to disengage the player.

This over-complicatedness leading to disengaging the player can also happen from non-linear gameplay. If the web of effects becomes sufficiently complicated and finding the optimal progression route too time-consuming to discover, players will seek out guides from other players who've completed the game. The second they do this, the game effectively becomes linearly following the instructions of the guide and all the above criticisms apply. Similarly to as before, though, this is a spectrum and not everyone will seek out a guide at the same level of difficulty.

Automation ​

Automation is a staple of the genre, but it has certain implications for the design of the game. Why, when new content is introduced, must the older content be automated away - why is it a chore and it feels rewarding to not have to do it again? Why does the new mechanic have such appeal if we know it too will just be automated away later on, and we'll be happy when that happens? It honestly begs the question of why this framework of introducing content and automating the old content is even enjoyable - and nearly nonexistent in other genres. You're not going to reach a point in a platformer game where they just automate the jumping part - that's the core mechanic! Instead, platformers either add new mechanics that build on the core mechanic or at least re-contextualize the core mechanic. However, in incremental games new content very frequently means replacing older content, as opposed to augmenting it.

Admittedly, the above paragraph ignores the obvious answer that separates incremental games in this regard. These mechanics become chores as their frequency increases. The frequency increases to give a sense of progression, and automation is seen as a reward because it now manages what was becoming unmanageable. The new content then comes in and continues the loop to give a stronger sense of progression. That's all good and a fine justification for automating content instead of building upon the base mechanic. It's also much easier to design, as each layer essentially lets you start over instead of needing to think of ideas that conform to the original core mechanic.

So, what's the problem? Even if this trend is justified and easy to implement, there are some other effects it has on the game design. First off, and this is probably a neutral point, incremental games with this cycle of replacing old mechanics with new ones trend towards more and more abstract and further away from any narrative throughline as they add layers. There are only so many justifications for resetting progress, so if a game wants to have several of these layers they're inevitably going to become generic or increasingly loosely associated with the original content. It's most unfortunate, in my opinion when an interesting or innovative core mechanic gets fully automated once a generic "prestige" layer is unlocked.

A recent example is Really Grass Cutting Incremental, an incremental game about cutting grass. Except, it doesn't continue to be about cutting grass. After you buy enough upgrades to increase your grass cutting and level up sufficiently you "prestige", an abstract term that in this case means you reset all your progress to get some currency to buy upgrades that do the same things as the original upgrades, but these won't reset on future prestiges. You'll eventually be able to "crystallize", which means you reset all your progress to get some currency to buy upgrades that do the same things as the original upgrades (and a couple of new ones) and won't reset on future crystallizes. Fine. You'll progress a bit, complete some challenges, and finally get to... grasshop? Grasshopping is this mechanic where you reset all your progress to get some resource that isn't for buying upgrades - this time you just unlock different modifiers on everything based on their amount. You may have gotten the point by now, but there are also "steelie" resets which give you steel for some reason, before unlocking a factory with various machines - none of which are directly tied to cutting grass, and start gathering things like oil and reset for rocket parts and reset to go to space and so on and so on. Throughout all of this there is absolutely no narrative justification or throughline for the direction the game is going, or why cutting grass is still relevant when we're collecting things like rocket parts. I may be going a little hard on GCI, but it is far from alone.

Tips for Developers ​

If you're a developer, by this point you should have a pretty decent idea of how to create "true" content in your game. Here are some other specific tips I'd suggest:

  • An upgrade that simply unlocks another upgrade trivially isn't content. However, many games have an upgrade that just unlocks a feature, which then has a wait or other requirements before it can be used. Try to make sure when you unlock a feature, there is immediately something to do with the feature - for example, perhaps give them a small amount of the new currency it unlocks, if applicable.
  • If you don't have a large web of effects, and can definitively say the impact of a purchase is to multiply the gain of the cost currency by N, and the next purchase costs N times the amount of that same currency, then this purchase effectively made no difference and it may have made more sense to just go directly to the next upgrade. That said, having effects based on things like the number of purchases made will quickly invalidate this tip.
- + \ No newline at end of file diff --git a/guide-to-incrementals/ludology/definition/index.html b/guide-to-incrementals/ludology/definition/index.html index c7b7a162..3fb16bc8 100644 --- a/guide-to-incrementals/ludology/definition/index.html +++ b/guide-to-incrementals/ludology/definition/index.html @@ -26,7 +26,7 @@

Appearance

Defining the Genre ​

Video games are placed into genres for a variety of reasons. They can give a mental shorthand to set the player's expectations up, they can help a game market itself by its similarities to other, already popular games, and honestly, people just love categorization for its own sake. For this guide, it's important to define the genre so it is clear what games it's even talking about.

This poses a problem. "Incremental" is a horribly vague way to define games. Most games have numbers going up in some form or another. We need a more specific definition - similar to how "strategy" can't just mean any game with any amount of strategy because that would be most games. What specifically differentiates incremental games from the rest?

"Incremental" implies it's a genre defined by a game mechanic, but all those game mechanics it could imply exist in many other games. Having a skill tree or upgrades doesn't make you incremental, and if a reset mechanic is all it takes then every roguelite would be an incremental as well. So clearly there's more to it than that - what makes an incremental an incremental?

I'd like to go over a couple of popular suggestions I've seen on defining the genre here. I have my personal preferences and will state them here, but I don't think there's a truly perfect answer here.

Disclaimer: I mostly play incremental games on my computer, and my definitions will be heavily biased towards the games I'm familiar with.

Incrementals vs Idlers vs Clickers ​

Oftentimes people refer to this genre as idle games and/or clicker games. You'll even find a trend of oxymoronic game titles that contain both terms. "Incremental games" is the umbrella term both those terms fall under. However, I'd like to argue that not only is it better to just use the term "incremental games", but calling them "idle games" or "clicker games" is wrong. Almost universally, these terms are used interchangeably to refer to the same kind of game, where you start the game click spamming and eventually automate the process. Frankly, that kind of game deserves neither title, and the genre of incremental games has trended away from ever requiring click spamming, as it's a bad mechanic, anyways.

While these games do span a spectrum of how active it requires you to be, and sorting games by that metric can be useful for those looking for a particular experience, the borders of when an incremental game counts as an "idler" is too blurry for the term to be useful. "Incremental games" may not be a great descriptive term for the genre (hence this many thousands of words long page on defining what the genre even is), but it's strictly better than calling them "idler" or "clicker" games. This guide will always use the term "incremental games" unless quoting someone else, as it is the term you typically see on all modern games in the genre.

Incrementals as Parodies ​

Let's start with one of the most interesting definitions of incremental games. Incremental games appear to be distilled versions of games or genres, "revealing" the naked game design at the core of these games or genres not unlike how parodies comment upon their source material.

To understand what that means, think of how a casino uses skinner boxes to emotionally manipulate its customers to keep playing, but "dressing" up the skinner box with tons of stimuli to hide that ultimately the goal is to condition you into coming back compulsively. The idea that incremental games are parodies means taking the stance that at some level all games are similarly manipulating you, giving dopamine rewards in a way that manipulates you to keep playing while not necessarily giving you any value or fulfillment. Incremental games, then, are any games that plainly display the skinner box, and the manipulative core of the game, at the forefront of the experience.

While incremental games can be fun and even healthy in certain contexts, they can exacerbate video game addiction more than other genres. If you feel like playing incremental games is taking priority over other things in your life, or manipulating your sleep schedule, it may be prudent to seek help. See r/StopGaming for resources.

This "undressing" tends to go hand in hand with a reduced focus on aesthetics, often just printing the game state directly to the screen as text. This makes incremental games much easier to develop, particularly for those with programming skills but not art skills, but that's a tangent for why Incremental Games appeal to Developers.

Before I continue, I'd like to make my stance clear that I love games and incremental games, and do not think they should be considered inherently bad or manipulative with the above logic. Skinner boxes are just a way of manipulating behavior via rewards. The games are still fun - that's the reward! I'd believe the real criticism here is that it is "empty fun", or "empty dopamine", that doesn't offer any additional value or sense of fulfillment. I don't think that's inherently bad in moderation, although it can become a problem if the game is manipulating you for profit-seeking, or if you play the game to the detriment of the other parts of your life.

Another interpretation of incremental games as parodies comes from several mainstream incremental games that are also parodies of capitalism, such as cookie clicker and adventure capitalist. It's a very common framework for incremental games to portray the ever-increasing numbers as an insatiable hunger for resources, like the ones observed within capitalism. Therefore, these games are used as evidence that the genre as a whole is about parody and commentary.

Popular videos on incremental games that portray the genre as parodies are Why Idle games make good satire, and how it was ruined. and Bad Game Design - Clicker Games. You may also be interested in this response to the latter video from a fan of incremental games: BadGood Game Design - Clicker Games.

I think that this definition ultimately ascribes a motive to the genre as a whole that only happens to apply to some of the more mainstream titles. There certainly are incremental games commenting on different things, including the genre itself as in the case of The Prestige Tree Classic, The Ascension Tree, or Omega Layers, but certainly not all. And of course, not all games that comment on something or parody something are incremental games! Additionally, a very large majority of incremental games are mobile games using these manipulative strategies to get players to spend as much money as possible - hell, Adventure Capitalist is ostensibly a critique on capitalism but features microtransactions and gameplay that manipulates you into buying them! These profit-seeking incremental games certainly belong within the genre but are hardly parodies when they too use manipulation to serve their interests. Also, from my own anecdotal experience, those who use this definition seem to do so from a fairly surface-level familiarity with the genre, and often in the context of criticizing the genre or the fans thereof.

Incrementals as NGU ​

Another broad definition often used is that incremental games are games where the focus of the game is "numbers going up". This definition proposes that other genres simply use increasing numbers as a means to an end, but incremental games uniquely only care about the numbers themselves going up. Put another way, it implies there should be no narrative justification for the numbers going up other than "why shouldn't they be going up?"

While this definition is common because it feels easy to understand, it is difficult to formally define. Often phrases are used to describe games using this framework, such as having an "exaggerated sense of progression" or "big" numbers. These terms are vague and don't demonstrate an actual threshold between non-incrementals and incrementals. Most games have a sense of progression, so when is it "exaggerated"? How big are "big" numbers? Most notably, RPGs that are typically not considered incrementals will often pass this definition.

Additionally, a lot of incrementals tend to have some theme guiding the gameplay, or at least the names of mechanics. This makes the line blurred between when numbers are going up for their own sake versus for a contextual reason. I believe this point is best illustrated that, while most RPGs are not considered incremental games, there is a sub-genre of "incremental RPGs" that typically relates to RPGs that perform combat automatically. This definition of incremental games does not support RPGs and "incremental RPGs" being on distinct sides of the line if the only difference between them is manual vs automatic combat.

Incrementals as Strategies ​

This is a rarer interpretation, but there are similarities between incremental games and strategy games, implying incrementals might just be a sub-genre of strategy games. By this approach, incremental games would be defined by their relation to strategy games, and how they involve player strategy. Incremental games are often large optimization problems - above all else, the actual gameplay the player is performing is deciding what to do next. The consequences of wrong decisions are typically more lenient in incremental games - such as just not making optimal progress - but they certainly get complex.

So if we accept the premise that incrementals could fall under strategy, we still need to define what makes a strategy game an incremental versus some other strategy sub-genre. This is a bit tricky due to one particular sub-genre of strategy games: Factory Builders.

Factory builders, such as Factorio or Satisfactory, are games about gaining ever increasing resources, optimizing production, and expanding more and more. That... sounds pretty similar, doesn't it? In fact, there's been some debate on whether factory builders would fall under the "incremental" umbrella. I think it's safe to say the two are certainly related, and probably have quite a bit of overlap in playerbase.

Roguelites as Incrementals? ​

Earlier on, I mentioned reset mechanics shouldn't be used in the definition because that could make all roguelites incrementals... But what if it does? A lot of incrementals can be described as games with a strong sense of progression, often with layers of meta-progression. Roguelites fit that bill to a T. What would make roguelites not incremental? I honestly don't think there's a good explanation here, but many fans of incremental games will state they do believe the two genres to be unrelated, even if there's a significant overlap between their player bases due to having similar appealing traits.

At this point, it'd be appropriate to consider what part of the definition of roguelites precludes them from also being incrementals, but that reveals a new problem: What are roguelites? They're usually defined as rogue_likes with meta-progression, but that just pushes the problem back a step: Incrementals aren't the only genre to have difficulties defining themselves, it seems! Roguelikes are another genre where the community argues over the formal definition of their genre, although that means we can borrow from their process of coming to a consensus, and maybe come across a viable definition for incremental games.

The Berlin Interpretation ​

By far the most popular way of defining roguelikes is the "Berlin Interpretation", which acknowledged the diversity of games within the genre and argued the definition should not be based on any ideals about what the genre ought to be, but rather defined by "its canon". They argued there are a handful of games that can be used to define the canon for roguelikes, and from those games, a list of factors can be derived to determine a game's "roguelikeness". The more factors a game has, the more of a roguelike it is. This strategy is very lenient, allowing a game to not present any specific factor so long as it shows enough, and accounts for the blurriness of any genre definition by not explicitly stating how many factors a game must have to qualify as a definite roguelike.

I believe this strategy for defining genres can be applied to other genres as well. A handful of games can be argued to be the incremental games canon, and a list of factors derived from them can be used to judge any game based on its "incrementalness". I'll propose such a canon and list of factors here, but by no means should it be considered the end-all-be-all.

Note: The "Temple of the roguelike", an authority within the genre, has since replaced the Berlin Interpretation with a new set of factors here: https://blog.roguetemple.com/what-is-a-traditional-roguelike/

The Incremental Games Canon ​

Alright, time to get controversial. Up til now, I've been trying my best to stay objective and analytical, but now it's time to start making some opinionated decisions. Here is a list of games I think could justifiably make up an Incremental Games Canon:

I chose a variety of games here, biasing towards newer games, purposefully to avoid making a narrow or "traditional" definition. The genre is growing and shouldn't be constrained by the traits of the early popular titles. A lot of these could easily be replaced with other games that are mechanically congruent, so ultimately I'm sure if you asked 10 people for their canon list you'd just get 10 different answers, but I think this should sufficiently allow us to determine what factors make a game have higher "incrementalness".

The Paradigm Shift ​

The Paradigm Shift is probably the highest possible value factor for an incremental. It's so common that for a while people referred to incrementals that exhibit this trait as "unfolding" games, to the point of trying to replace the term incremental due to their popularity. Paradigm shifts refer to when the gameplay significantly changes. There are too many examples to list here, but notably, every single reset mechanic is typically going to be a paradigm shift. Examples of games with paradigm shifts that aren't tied to reset mechanics include Universal Paperclips and A Dark Room.

There are many reasons for the appeal of paradigm shifts. Oftentimes each mechanic builds on top of the existing mechanics, increasing the complexity of the game in steps so the player can follow along. They provide a sense of mystery, with the player anticipating what will happen next. They shake up the gameplay before it gets too stale - allowing the game to entertain for longer before the illusion of content dissipates. Of the canon games selected above, I would argue every single one contains a paradigm shift (although I could see someone disagreeing with that statement wrt Increlution).

I should take a moment to say that while I'm hyping up this specific factor, we cannot just reduce the genre definition to "does it have paradigm shifts". Many games have paradigm shifts that are not incremental, so it's just an indicator of incrementalness. Additionally, it can become quite hard to determine how large of a shift is a "paradigm" shift. Take, for example, any game with a skill tree. In some games, each skill node might have a large impact on how you play with the game, and qualify as a paradigm shift for some players. In other games, each skill node might just be a small percentage modifier on some stat that doesn't really impact much more than a slight bias towards an already established mechanic that's newly buffed. Every single canon game may show that it's common amongst incremental games, but could just as easily indicate that they're common in games in general.

High-Value Factors ​

I won't take as long to discuss the high and low-value factors, as you've already seen most of them brought up earlier on this page. As a reminder, a game does NOT need all of these to be an incremental game, but these are factors that each indicate a strong possibility the game is an incremental, so having several of these means they probably are. These factors apply to most of the canon incremental games.

"Pure UI" Display. Incrementals typically have a textual presentation of the game state - there isn't a visual representation of the entities within the game. The interface is closer to what would be just the UI of a game in another genre or the control panel of a plane. If there is a visual representation, the player is often still interacting with non-diegetic game elements.

Reduced Consequences. Incrementals tend to have reduced repurcussions for misplaying. They very rarely have fail states, where often the largest consequence is simply not progressing - never losing progress.

Optimization Problems. The predominant gameplay of incrementals is typically solving optimization problems, from deciding which purchase to save up for to reasoning and deciding between different mutually exclusive options the game presents.

Resource Management. Incrementals tend to have a lot of resources within the game to keep track of.

Low-Value Factors ​

These are low-value factors, meaning they aren't as strongly correlated with incremental games. Incremental games may have none of these, and non-incrementals may have several of these - if a game only has low-value factors, they're probably not an incremental.

Fast Numeric Growth. Numbers in incremental games tend to grow faster than in other genres. There are more instances of superlinear growth. The larger the numbers get, the stronger of a signal this factor is.

Automation. As an incremental game progresses, the player often no longer has to deal with earlier mechanics, by having them either happen automatically or otherwise be replaced with an alternative that requires less player interaction.

Goal-Oriented. Incrementals are often heavily reliant on extrinsic motivation to guide the player. Typically this is through some sort of in-game goal to work towards, such as a certain amount of a resource being required to unlock or purchase something new.

Waiting is a Mechanic. In incremental games, the player may come across times where there is no action they can take, and the game will progress automatically instead. The player must wait for some amount of this automatic progress to occur before they can resume interaction with the game.

Are Roguelites Incrementals? ​

Having made our variation of the Berlin Interpretation for incremental games, we can compare it to the Berlin Interpretation to determine if there's enough overlap that any game that "passes" the Berlin Interpretation would also pass the incremental variant. That is to say, whether any roguelite would also be considered an incremental game.

The meta-progression of an incremental game could arguably be considered a paradigm shift, and certainly adds some resource management. Goal-oriented would probably also apply. I think anything other than those would be a stretch, and in my opinion that just isn't enough to qualify. To be totally honest, I was never expecting to conclude otherwise though 😉

Sub-Genres ​

There are some trends in incremental games that go beyond just being a commonly used mechanic, such that they deeply affect the rest of the game design. These trends can be used to determine sub-genres within the incremental games umbrella:

  • Loops games are a sub-genre defined by having a core mechanic related to a loop, where the player is deciding the actions taken per loop. Notable examples include Idle Loops, Stuck in Time, Cavernous II, and Increlution. You may also argue Groundhog Life and Progress Knight fall into this sub-genre.
  • ITRTG-like games are a sub-genre defined by having a core mechanic based on clearing increasingly difficult battles and often tend to have a lot of different mechanics to become progressively stronger. Notable examples include Idling to Rule the Gods, NGU Idle, and Wizard and Minion Idle.
  • Polynomial Growth games are a sub-genre defined by having a core mechanic related to a higher degree polynomial. Notable examples include the base layer of Antimatter Dimensions and Swarm Simulator.
  • Upgrades Games is a category popular on flash games websites that featured games focused on buying upgrades that would allow you to attain more currency in some sort of minigame that would earn you more money to buy more upgrades, which I'd argue now belong under the fold of incremental games. Notable examples include the Learn to Fly series and Upgrade Complete.
  • Cultivation RPGs are a genre of games, books, and anime popular in China that center around being in a fantasy world with characters getting stronger over time. While few of them get translated into English, a fan of incremental games may find the available games interesting.
- + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index 4793012b..de36ca49 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"guide-to-incrementals_index.md":"ae9d9abe","guide-to-incrementals_ludology_appeal-gamers_index.md":"632c1a6c","guide-to-incrementals_design_criticism_index.md":"babc7a8a","guide-to-incrementals_ludology_appeal-developers_index.md":"1d7907d2","guide-to-incrementals_ludology_definition_index.md":"095695b4","public_gamedevtree_docs_bars.md":"ec7cc351","projects_citadel_index.md":"107fdf79","public_gamedevtree_docs_milestones.md":"45921247","public_gamedevtree_docs_upgrades.md":"4d0193f7","public_gamedevtree_docs_updating-tmt.md":"63426774","public_kronos_old things_2.0-format-changes.md":"ed0a3b56","guide-to-incrementals_ludology_content_index.md":"15f98889","guide-to-incrementals_design_introduction_index.md":"bd80dacf","public_gamedevtree_readme.md":"b6d559b4","public_gamedevtree_docs_custom-tab-layouts.md":"7aedc564","index.md":"86565ca9","public_gamedevtree_docs_getting-started.md":"a557674c","public_lit_docs_infoboxes.md":"a41a0b44","public_lit_docs_clickables.md":"6d4a150c","public_kronos_changelog.md":"aa100fa9","public_lit_changelog.md":"7ffc5c51","public_lit_docs_!general-info.md":"c7293c46","public_lit_docs_achievements.md":"ee32192a","public_lit_docs_bars.md":"b9fea664","public_lit_docs_basic-layer-breakdown.md":"6a713202","public_lit_docs_buyables.md":"de2579eb","public_lit_docs_custom-tab-layouts.md":"a8f21b42","public_lit_docs_getting-started.md":"3c9b54a0","public_lit_docs_layer-features.md":"42411a7c","public_lit_docs_main-mod-info.md":"85e59005","public_lit_docs_milestones.md":"c381f676","public_lit_docs_subtabs-and-microtabs.md":"67ff4512","public_lit_docs_trees-and-tree-customization.md":"b921bdd3","public_lit_docs_updating-tmt.md":"730c6932","public_lit_docs_upgrades.md":"3335058b","public_kronos_docs_challenges.md":"0c261e6f","public_gamedevtree_docs_clickables.md":"a194784a","public_lit_docs_challenges.md":"02d86b36","projects_index.md":"39a54339","public_gamedevtree_docs_layer-features.md":"1929a414","public_lit_readme.md":"76d585a3","public_kronos_docs_clickables.md":"40880b19","public_kronos_docs_custom-tab-layouts.md":"c9911269","public_kronos_docs_trees-and-tree-customization.md":"ee2f3f3e","public_kronos_docs_updating-tmt.md":"969c19e7","public_kronos_docs_upgrades.md":"39fd2dc4","public_lit_old things_2.0-format-changes.md":"7565a8c8","public_kronos_docs_!general-info.md":"9f7b2438","public_kronos_docs_basic-layer-breakdown.md":"81071a57","public_gamedevtree_2.0-format-changes.md":"ac2ca152","projects_babble_index.md":"346c2b79","projects_dice_index.md":"2aa1cd0a","public_gamedevtree_docs_challenges.md":"4cd0dae3","public_gamedevtree_docs_basic-layer-breakdown.md":"47a28d00","public_gamedevtree_docs_!general-info.md":"0c0e95e5","projects_vecs_index.md":"cfb70a46","projects_optispeech_index.md":"79247f34","public_gamedevtree_docs_infoboxes.md":"9018bc1b","public_gamedevtree_docs_subtabs-and-microtabs.md":"9a540a97","public_kronos_docs_achievements.md":"78408671","public_kronos_docs_buyables.md":"55819f1c","public_kronos_docs_bars.md":"66fd7014","public_kronos_docs_getting-started.md":"f44afdab","public_kronos_docs_grids.md":"bc6a5c92","public_kronos_docs_layer-features.md":"08845d86","public_kronos_docs_main-mod-info.md":"61c94c05","public_kronos_docs_milestones.md":"3197e6a0","public_kronos_docs_particles.md":"cf40ed2c","public_kronos_docs_subtabs-and-microtabs.md":"5d9833f5","public_kronos_docs_infoboxes.md":"4feac084","public_gamedevtree_docs_main-mod-info.md":"b50fb201","public_gamedevtree_changelog.md":"e23c2e43","public_kronos_readme.md":"55c5f567","public_gamedevtree_docs_achievements.md":"7f786d8e","public_gamedevtree_docs_buyables.md":"36128e10"} +{"public_gamedevtree_docs_buyables.md":"36128e10","public_gamedevtree_docs_custom-tab-layouts.md":"7aedc564","public_gamedevtree_2.0-format-changes.md":"ac2ca152","public_gamedevtree_docs_!general-info.md":"0c0e95e5","index.md":"dee1ce40","public_gamedevtree_changelog.md":"e23c2e43","guide-to-incrementals_index.md":"ae9d9abe","guide-to-incrementals_ludology_appeal-gamers_index.md":"632c1a6c","public_kronos_docs_custom-tab-layouts.md":"c9911269","projects_vecs_index.md":"2f7e22a7","public_gamedevtree_docs_achievements.md":"7f786d8e","public_gamedevtree_docs_infoboxes.md":"9018bc1b","public_gamedevtree_docs_basic-layer-breakdown.md":"47a28d00","public_gamedevtree_readme.md":"b6d559b4","guide-to-incrementals_design_introduction_index.md":"bd80dacf","public_kronos_docs_main-mod-info.md":"61c94c05","projects_citadel_index.md":"e4de060a","projects_optispeech_index.md":"8eeb4f1d","public_gamedevtree_docs_layer-features.md":"1929a414","public_gamedevtree_docs_milestones.md":"45921247","public_gamedevtree_docs_subtabs-and-microtabs.md":"9a540a97","guide-to-incrementals_design_criticism_index.md":"babc7a8a","public_gamedevtree_docs_main-mod-info.md":"b50fb201","public_gamedevtree_docs_updating-tmt.md":"63426774","public_gamedevtree_docs_upgrades.md":"4d0193f7","public_kronos_old things_2.0-format-changes.md":"ed0a3b56","public_gamedevtree_docs_getting-started.md":"a557674c","projects_index.md":"575a26a1","public_gamedevtree_docs_clickables.md":"a194784a","public_gamedevtree_docs_bars.md":"ec7cc351","public_kronos_readme.md":"55c5f567","public_kronos_docs_!general-info.md":"9f7b2438","public_kronos_docs_achievements.md":"78408671","public_lit_docs_getting-started.md":"3c9b54a0","public_lit_docs_upgrades.md":"3335058b","public_kronos_changelog.md":"aa100fa9","projects_dice_index.md":"f3f5673d","guide-to-incrementals_ludology_appeal-developers_index.md":"1d7907d2","public_kronos_docs_bars.md":"66fd7014","guide-to-incrementals_ludology_content_index.md":"15f98889","public_lit_docs_updating-tmt.md":"730c6932","public_kronos_docs_getting-started.md":"f44afdab","public_kronos_docs_basic-layer-breakdown.md":"81071a57","public_gamedevtree_docs_challenges.md":"4cd0dae3","projects_babble_index.md":"600d0df4","public_lit_docs_achievements.md":"ee32192a","public_kronos_docs_buyables.md":"55819f1c","public_kronos_docs_challenges.md":"0c261e6f","public_lit_docs_!general-info.md":"c7293c46","public_kronos_docs_clickables.md":"40880b19","public_lit_docs_subtabs-and-microtabs.md":"67ff4512","public_lit_changelog.md":"7ffc5c51","public_lit_docs_trees-and-tree-customization.md":"b921bdd3","guide-to-incrementals_ludology_definition_index.md":"095695b4","public_kronos_docs_infoboxes.md":"4feac084","public_kronos_docs_grids.md":"bc6a5c92","public_kronos_docs_particles.md":"cf40ed2c","public_kronos_docs_layer-features.md":"08845d86","public_kronos_docs_trees-and-tree-customization.md":"ee2f3f3e","public_kronos_docs_updating-tmt.md":"969c19e7","public_kronos_docs_subtabs-and-microtabs.md":"5d9833f5","public_lit_docs_clickables.md":"6d4a150c","public_kronos_docs_upgrades.md":"39fd2dc4","public_lit_old things_2.0-format-changes.md":"7565a8c8","public_lit_readme.md":"76d585a3","public_lit_docs_basic-layer-breakdown.md":"6a713202","public_lit_docs_buyables.md":"de2579eb","public_lit_docs_challenges.md":"02d86b36","public_lit_docs_layer-features.md":"42411a7c","public_kronos_docs_milestones.md":"3197e6a0","public_lit_docs_custom-tab-layouts.md":"a8f21b42","public_lit_docs_infoboxes.md":"a41a0b44","public_lit_docs_main-mod-info.md":"85e59005","public_lit_docs_milestones.md":"c381f676","public_lit_docs_bars.md":"b9fea664"} diff --git a/index.html b/index.html index 4b096e7f..0960cd7b 100644 --- a/index.html +++ b/index.html @@ -11,7 +11,7 @@ - + @@ -26,7 +26,7 @@

Appearance

The Paper Pilot

I'm Anthony, or The Paper Pilot, and I make fun games and tools!

My Projects
My Resume
🧑‍💻

Profectus

A game engine that grows with you

👤

Incremental Social

A kind social media site for the incremental games community

🎮

My Games

Most of my games are playable on Itch

- + \ No newline at end of file diff --git a/projects/babble/index.html b/projects/babble/index.html index 4e5cd6e0..4fe40fd5 100644 --- a/projects/babble/index.html +++ b/projects/babble/index.html @@ -11,7 +11,7 @@ - + @@ -25,8 +25,8 @@

Appearance

Babble Buds ​

Babble Buds Homepage

Source Code:

Babble buds is a free, open-source virtual puppet show software. It is heavily based on the non-public software called "Puppet Pals", used in URealms Live. The software is written in javascript using React, a rendering library called PIXI.js, and electron.

Users can create puppets with different faces for different emotions, and then use the puppet on a stage where you and other users can each make your respective puppets move, change emotions, and "babble" at each other. The stage has a green screen feature and can be popped out, which gives the users tons of possibilities in terms of using the program for a role-playing live stream, faux video chatting with friends, game development, or whatever else you want!

Users can connect to the public server and create private rooms so that they and their friends can see each other's puppets and use the software however they please. For the security conscious, you can also use the server's source code to self-host your private server.

Babble Buds Screenshot

Engine ​

The engine originally made to make the Babble Buds program was separated into a separate engine called babble.js, so that projects created in Babble Buds can be used in other projects. For example, a game can create puppets in Babble Buds and then use them for cutscenes or player agency inside of the game. Additionally, it has been ported to C# (called babble.cs) for use with Unity, for the same kinds of purposes. You can check out Tower Offense for a pixi.js game using Babble Buds puppets for the cutscenes, or Dice Armor for a unity game using Babble Buds puppets for the cutscenes.

Babble Movie Maker ​

Babble Movie Maker is a cutscene editor for Babble Buds puppets. You open a babble buds project in it, and you can add actors to a stage and have them move and change expressions, etc., on a timeline. You can then use the cutscene in a game using babble.js or babble.cs, or export the cutscene into a video file. There is even support for defining custom commands with custom fields, so that if you've expanded upon the default actions provided in babble.js or babble.cs, you can still use Movie Maker to create your cutscenes.

Babble MM Screenshot

- +

Babble Buds ​

Babble Buds Homepage

Source Code:

Babble buds is a free, open-source virtual puppet show software. It is heavily based on the non-public software called "Puppet Pals", used in URealms Live. The software is written in javascript using React, a rendering library called PIXI.js, and electron.

Users can create puppets with different faces for different emotions, and then use the puppet on a stage where you and other users can each make your respective puppets move, change emotions, and "babble" at each other. The stage has a green screen feature and can be popped out, which gives the users tons of possibilities in terms of using the program for a role-playing live stream, faux video chatting with friends, game development, or whatever else you want!

Users can connect to the public server and create private rooms so that they and their friends can see each other's puppets and use the software however they please. For the security conscious, you can also use the server's source code to self-host your private server.

Babble Buds Screenshot

Engine ​

The engine originally made to make the Babble Buds program was separated into a separate engine called babble.js, so that projects created in Babble Buds can be used in other projects. For example, a game can create puppets in Babble Buds and then use them for cutscenes or player agency inside of the game. Additionally, it has been ported to C# (called babble.cs) for use with Unity, for the same kinds of purposes. You can check out Tower Offense for a pixi.js game using Babble Buds puppets for the cutscenes, or Dice Armor for a unity game using Babble Buds puppets for the cutscenes.

Babble Movie Maker ​

Babble Movie Maker is a cutscene editor for Babble Buds puppets. You open a babble buds project in it, and you can add actors to a stage and have them move and change expressions, etc., on a timeline. You can then use the cutscene in a game using babble.js or babble.cs, or export the cutscene into a video file. There is even support for defining custom commands with custom fields, so that if you've expanded upon the default actions provided in babble.js or babble.cs, you can still use Movie Maker to create your cutscenes.

Babble MM Screenshot

+ \ No newline at end of file diff --git a/projects/citadel/index.html b/projects/citadel/index.html index 3875e705..bdf0dc63 100644 --- a/projects/citadel/index.html +++ b/projects/citadel/index.html @@ -11,7 +11,7 @@ - + @@ -25,8 +25,8 @@

Appearance

Capture the Citadel ​

A 3D VR re-envisioning of a Slay the Spire-style game by Anthony Lawn and Grant Barbee for their VR class in college's final project.

For more details, visit Grant's page on the game.

Screenshot

- +

Capture the Citadel ​

A 3D VR re-envisioning of a Slay the Spire-style game by Anthony Lawn and Grant Barbee for their VR class in college's final project.

For more details, visit Grant's page on the game.

Screenshot

+ \ No newline at end of file diff --git a/projects/dice/index.html b/projects/dice/index.html index f20e548a..e3526c8f 100644 --- a/projects/dice/index.html +++ b/projects/dice/index.html @@ -11,7 +11,7 @@ - + @@ -25,8 +25,8 @@

Appearance

Dice Armor ​

Download Here

Dice Armor is a game that started development as a semester-long project by a team of nine: a producer, a creative director, a narrative writer, an artist, two programmers, and 3 game designers. The information here is about my contributions as the lead programmer over the semester because I can show off stuff like the editor scripts I wrote. I was doing everything from interface coding, editor scripts, integrating Babble Buds, and of course, everything related to the gameplay itself. To date I'm still the lead programmer for the game; for more up-to-date information on the current state of the game please visit the official site.

The build available here was created for showing off at the end of the semester, and as such has some buttons present to make the game easier to skip parts of the game to see all the content: You start with all the dice in the game already in the shop, there's a button to give yourself free money to buy these dice with, and in the duel, there are buttons to force a win or a loss, which can be used to skip the tutorial (not recommended for first-time players).

Tutorial

Dice Armor is a dice dueling game. Players can use abilities, flip dice, and attack each other to win in a dice game that puts chance into the hands of the players. This is what the dueling scene looks like, with a tutorial cutscene happening on top to guide the player through the basics. Also, all the dice are constructed dynamically, using quaternion math to figure out the placement of each component relative to the face it is going on. The die in the middle has one of the player' and opponents' portraits on each of its sides.

Editors

For many of the objects I've created, I've made scriptable objects so that game designers can add and modify them easily. Additionally, I would create custom inspectors for the objects to help make them as easy to understand and edit as possible. The opponent's artificial intelligence is made up of many strategies, in a prioritized list. When it is the opponents' turn they go through each strategy and check if they can be run, and if so then the opponent performs the strategy and starts back over at the top of the list of strategies. The + sign under the list of strategies opens an organized dropdown of all the various strategies.

Simulator

In addition to custom inspector code, I've created new tools for the editor for our game designers to use. This is a duel simulator that will take two opponents and simulate an arbitrary number of duels between them, and output the results and summarize them for you, much much quicker than manually going through the duels, even with an absurdly high timeScale. This will become incredibly useful in making balance changes and testing new dice against existing sets. This is a screenshot of it in edit mode, but in play mode it removes the "Dueling Managers" field and will use whatever the current duel balance settings are, allowing for the GDs to test freely in play mode without worrying about undoing all their changes afterward.

Cutscene

I created the Babble Buds puppet editor and ported the rendering library I wrote for it to C# so it could be used in Unity. Dice Armor has a full campaign using cutscenes made using the Babble Buds cutscene editor, taking advantage of its support for custom commands and fields to control things like talking, giving the player dice and money, starting duels, and controlling player progression through the story.

Action Wheel

When a cutscene ends, its final command is to either start a duel or set the next cutscene in the story. In the latter case, there is an additional field for what to call the next cutscene, and what location it takes place. The cutscene is then added to the player's save file, and when they visit the city locations are greyed out until they have at least one action to do there. Each location has a dynamically populated action wheel with a custom range of acceptable angles.

Shop

The dice shop is dynamically populated by a list of dice available to the player, which can be changed during cutscenes, and is checked against the dice owned by the player to generate sold-out indicators. On the left, the player can choose to filter the options down to a single dice effect, which also updates the "Buy All" button to buy only all the dice in the current filter.

Inventory

The inventory works most the same as the shop, but for equipping dice. It also allows you to drag individual dice or entire sets to the equipped dice glyph. While dragging it will highlight all the slots the new dice will be equipped into.

Dice Rolling

The dice rolling uses the physics engine and detects once the dice have stopped moving, then determines which side is face up based on which of the normals is closest to straight up. It flags the die as cocked if that smallest angle is above a threshold. The dice sink into the table when not rolling to not interfere with any dice that are rolling.

Missile Storm

During certain events like winning the game or having the face of a die broken, the players' portraits will flash an emotion for a second. After winning, a random living die from the winning player is chosen to play their "finisher move", a flashy and dramatic effect to end the game. Shown is the arcane mechana's finisher, "Missile Storm".

- +

Dice Armor ​

Download Here

Dice Armor is a game that started development as a semester-long project by a team of nine: a producer, a creative director, a narrative writer, an artist, two programmers, and 3 game designers. The information here is about my contributions as the lead programmer over the semester because I can show off stuff like the editor scripts I wrote. I was doing everything from interface coding, editor scripts, integrating Babble Buds, and of course, everything related to the gameplay itself. To date I'm still the lead programmer for the game; for more up-to-date information on the current state of the game please visit the official site.

The build available here was created for showing off at the end of the semester, and as such has some buttons present to make the game easier to skip parts of the game to see all the content: You start with all the dice in the game already in the shop, there's a button to give yourself free money to buy these dice with, and in the duel, there are buttons to force a win or a loss, which can be used to skip the tutorial (not recommended for first-time players).

Tutorial

Dice Armor is a dice dueling game. Players can use abilities, flip dice, and attack each other to win in a dice game that puts chance into the hands of the players. This is what the dueling scene looks like, with a tutorial cutscene happening on top to guide the player through the basics. Also, all the dice are constructed dynamically, using quaternion math to figure out the placement of each component relative to the face it is going on. The die in the middle has one of the player' and opponents' portraits on each of its sides.

Editors

For many of the objects I've created, I've made scriptable objects so that game designers can add and modify them easily. Additionally, I would create custom inspectors for the objects to help make them as easy to understand and edit as possible. The opponent's artificial intelligence is made up of many strategies, in a prioritized list. When it is the opponents' turn they go through each strategy and check if they can be run, and if so then the opponent performs the strategy and starts back over at the top of the list of strategies. The + sign under the list of strategies opens an organized dropdown of all the various strategies.

Simulator

In addition to custom inspector code, I've created new tools for the editor for our game designers to use. This is a duel simulator that will take two opponents and simulate an arbitrary number of duels between them, and output the results and summarize them for you, much much quicker than manually going through the duels, even with an absurdly high timeScale. This will become incredibly useful in making balance changes and testing new dice against existing sets. This is a screenshot of it in edit mode, but in play mode it removes the "Dueling Managers" field and will use whatever the current duel balance settings are, allowing for the GDs to test freely in play mode without worrying about undoing all their changes afterward.

Cutscene

I created the Babble Buds puppet editor and ported the rendering library I wrote for it to C# so it could be used in Unity. Dice Armor has a full campaign using cutscenes made using the Babble Buds cutscene editor, taking advantage of its support for custom commands and fields to control things like talking, giving the player dice and money, starting duels, and controlling player progression through the story.

Action Wheel

When a cutscene ends, its final command is to either start a duel or set the next cutscene in the story. In the latter case, there is an additional field for what to call the next cutscene, and what location it takes place. The cutscene is then added to the player's save file, and when they visit the city locations are greyed out until they have at least one action to do there. Each location has a dynamically populated action wheel with a custom range of acceptable angles.

Shop

The dice shop is dynamically populated by a list of dice available to the player, which can be changed during cutscenes, and is checked against the dice owned by the player to generate sold-out indicators. On the left, the player can choose to filter the options down to a single dice effect, which also updates the "Buy All" button to buy only all the dice in the current filter.

Inventory

The inventory works most the same as the shop, but for equipping dice. It also allows you to drag individual dice or entire sets to the equipped dice glyph. While dragging it will highlight all the slots the new dice will be equipped into.

Dice Rolling

The dice rolling uses the physics engine and detects once the dice have stopped moving, then determines which side is face up based on which of the normals is closest to straight up. It flags the die as cocked if that smallest angle is above a threshold. The dice sink into the table when not rolling to not interfere with any dice that are rolling.

Missile Storm

During certain events like winning the game or having the face of a die broken, the players' portraits will flash an emotion for a second. After winning, a random living die from the winning player is chosen to play their "finisher move", a flashy and dramatic effect to end the game. Shown is the arcane mechana's finisher, "Missile Storm".

+ \ No newline at end of file diff --git a/projects/index.html b/projects/index.html index 58cbba0c..3a46d94a 100644 --- a/projects/index.html +++ b/projects/index.html @@ -11,7 +11,7 @@ - + @@ -25,8 +25,8 @@

Appearance

Games and Tools ​

Check out the various games and tools I've made or worked on in the sidebar!

- +

Games and Tools ​

Check out the various games and tools I've made or worked on in the sidebar!

+ \ No newline at end of file diff --git a/projects/optispeech/index.html b/projects/optispeech/index.html index c89269b8..1aba71ec 100644 --- a/projects/optispeech/index.html +++ b/projects/optispeech/index.html @@ -11,7 +11,7 @@ - + @@ -25,8 +25,8 @@

Appearance

OptiSpeech ​

The Optispeech project involves designing and testing a real-time tongue model that can be viewed in a transparent head while a subject talks — for the purposes of treating speech errors and teaching foreign language sounds. This work has been conducted in partnership with Vulintus and with support from the National Institutes of Health (NIH). The UT Dallas Speech Production Lab is currently updating the program to use updated versions of Unity and adding support for more features and hardware.

System Architecture

This video shows a talker with WAVE sensors placed on the tongue hitting a virtual target sphere located at the alveolar ridge. When an alveolar consonant is hit (e.g., /s/, /n/, /d/) the sphere changes color from red to green.

This video shows an American talker learning a novel sound not found in English. When the post-alveolar consonant is hit, the target sphere changes color from red to green. Here, the NDI WAVE system serves as input.

The program is being updated by a team in the UT Dallas Speech Production Lab led by Anthony Lawn, so the program uses a more modern version of Unity, has an easier-to-use interface, can more easily support new features, and can connect to additional EMA systems, namely the Carstens AG501.

New Interface

In addition, the program now includes documentation and unit tests to improve program stability and maintainability going forward.

Documentation

Unit Tests

- +

OptiSpeech ​

The Optispeech project involves designing and testing a real-time tongue model that can be viewed in a transparent head while a subject talks — for the purposes of treating speech errors and teaching foreign language sounds. This work has been conducted in partnership with Vulintus and with support from the National Institutes of Health (NIH). The UT Dallas Speech Production Lab is currently updating the program to use updated versions of Unity and adding support for more features and hardware.

System Architecture

This video shows a talker with WAVE sensors placed on the tongue hitting a virtual target sphere located at the alveolar ridge. When an alveolar consonant is hit (e.g., /s/, /n/, /d/) the sphere changes color from red to green.

This video shows an American talker learning a novel sound not found in English. When the post-alveolar consonant is hit, the target sphere changes color from red to green. Here, the NDI WAVE system serves as input.

The program is being updated by a team in the UT Dallas Speech Production Lab led by Anthony Lawn, so the program uses a more modern version of Unity, has an easier-to-use interface, can more easily support new features, and can connect to additional EMA systems, namely the Carstens AG501.

New Interface

In addition, the program now includes documentation and unit tests to improve program stability and maintainability going forward.

Documentation

Unit Tests

+ \ No newline at end of file diff --git a/projects/vecs/index.html b/projects/vecs/index.html index 93b07cab..0b2cbe37 100644 --- a/projects/vecs/index.html +++ b/projects/vecs/index.html @@ -11,7 +11,7 @@ - + @@ -25,8 +25,8 @@

Appearance

V-ecs ​

V-ecs Screenshot

V-ecs (pronounced "Vex") is a Vulkan-based engine I made for making highly moddable games and tools in Lua centered around the ECS design pattern and a work-stealing job system.

The engine works with "worlds", which are collections of systems and renderers. The engine comes with several worlds using systems and renderers I made, including a voxel world, an incremental game, and some test scenes. All of these include systems to render the fps as well as show a debug console by typing the grave key (`). The default world is a title screen that detects any worlds in the "worlds" folder and displays a button for each of them.

Debug Menu

The original plans were to eventually put it on the steam workshop so people could more easily share their creations amongst each other, but I never became happy enough with the performance of the engine - the parallelization of the lua code involved a lot of overhead that severely limited performance.

Instead, I made a couple of worlds by myself - an infinite procedurally generated voxel world, a simple incremental game, and a more complex incremental game I call "Sands of Time".

Sands of Time

- +

V-ecs ​

V-ecs Screenshot

V-ecs (pronounced "Vex") is a Vulkan-based engine I made for making highly moddable games and tools in Lua centered around the ECS design pattern and a work-stealing job system.

The engine works with "worlds", which are collections of systems and renderers. The engine comes with several worlds using systems and renderers I made, including a voxel world, an incremental game, and some test scenes. All of these include systems to render the fps as well as show a debug console by typing the grave key (`). The default world is a title screen that detects any worlds in the "worlds" folder and displays a button for each of them.

Debug Menu

The original plans were to eventually put it on the steam workshop so people could more easily share their creations amongst each other, but I never became happy enough with the performance of the engine - the parallelization of the lua code involved a lot of overhead that severely limited performance.

Instead, I made a couple of worlds by myself - an infinite procedurally generated voxel world, a simple incremental game, and a more complex incremental game I call "Sands of Time".

Sands of Time

+ \ No newline at end of file diff --git a/public/gamedevtree/2.0-format-changes.html b/public/gamedevtree/2.0-format-changes.html index 7694228b..99f20b5f 100644 --- a/public/gamedevtree/2.0-format-changes.html +++ b/public/gamedevtree/2.0-format-changes.html @@ -26,7 +26,7 @@

Appearance

2.0 format changes ​

  • Temp format is changed from temp.something[layer] to temp[layer].something, for consistency
  • Challenges are now saved as an object with the amount of completions in each spot. (This will break saves.)
  • effectDisplay in Challenges and Upgrades no longer takes an argument, and neither does effect for Buyables
  • Buyable cost can take an argument for amount of buyables, but it needs to function if no argument is supplied (it should do the cost for the next purchase).
  • Generation of Points now happens in the main game loop (not in a layer update function), enabled by canGenPoints in game.js.
  • Changed fullLayerReset to layerDataReset, which takes an array of names of values to keep

In addition, many names were changed, mostly expanding abbreviations:

All instances of:

  • chall -> challenge
  • unl -> unlocked
  • upg -> upgrade (besides CSS)
  • amt -> amount
  • desc -> description
  • resCeil -> roundUpCost
  • order -> unlockOrder
  • incr_order -> increaseUnlockOrder

Challenges:

  • desc -> challengeDescription
  • reward -> rewardDescription
  • effect -> rewardEffect
  • effectDisplay -> rewardDisplay
  • active -> challengeActive

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/README.html b/public/gamedevtree/README.html index 82ca0292..2c9884a9 100644 --- a/public/gamedevtree/README.html +++ b/public/gamedevtree/README.html @@ -26,7 +26,7 @@

Appearance

The-Modding-Tree ​

A modified version of The Prestige Tree that is much easier to mod. It still requires programming knowledge, but it's mostly pretty easy things and copy/pasting.

Look here for a tutorial on getting started with modding with TMT

You can look in the documentation for more information on how it all works, or look at the code in layers.js to see what it all looks like.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/changelog.html b/public/gamedevtree/changelog.html index 909ec61b..678dde19 100644 --- a/public/gamedevtree/changelog.html +++ b/public/gamedevtree/changelog.html @@ -26,7 +26,7 @@

Appearance

The Game Dev Tree changelog: ​

v1.0.4 Version Bump [rebalanced,debuggedx3] - 2020-11-09 ​

  • Fixed refactorings 2, 3, and 4 not actually affecting productivity

v1.0.3 Version Bump [rebalanced,debuggedx2] - 2020-11-08 ​

  • Fixed API milestone 4 not working

v1.0.2 Version Bump [rebalanced,debugged] - 2020-11-08 ​

  • Fixed tree lines being hidden after hitting "keepGoing" in the victory screen

v1.0.1 Version Bump [rebalanced] - 2020-11-08 ​

  • Buffed several TAs

v1.0 Version Bump - 2020-11-08 ​

  • Finished row 4
  • Added colored text to lore
  • Fixed some visual bugs with milestones
  • Probably other stuff lol its been a week

v0.2.3 Stylish - 2020-10-30 ​

  • Re-styled basically everything
  • Added favicon
  • Added header bar
  • Added changelog

v0.2.2 Row 3 - 2020-10-22 ​

  • Removed debug statement
  • Moved milestones in F layer beneath the buyables

v0.2.1 Row 3 - 2020-10-21 ​

  • Fixed layers hiding
  • Fixed typos/minor issues
  • Fixed S layer being highlighted before you can unlock the layer

v0.2 Row 3 - 2020-10-21 ​

  • Implemented row 3

v0.1.1 Cash Influx [rebalanced] - 2020-10-19 ​

  • Fixed notification issue
  • Rebalanced to make early game faster and late game slower
  • Fixed other minor issues

v0.1 Cash Influx - 2020-10-19 ​

  • Implemented row 2

v0.0 Initial Commit - 2020-10-18 ​

  • Implemented row 1

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/!general-info.html b/public/gamedevtree/docs/!general-info.html index fafbac3b..50be00f4 100644 --- a/public/gamedevtree/docs/!general-info.html +++ b/public/gamedevtree/docs/!general-info.html @@ -26,7 +26,7 @@

Appearance

The-Modding-Tree ​

The main way to add content is through creating layers. You can either add a layer directly in the layers object in layersSupportjs, or declare it in another file and then do "addLayer(layername, layerdata)" (good for breaking things up into smaller files). The existing layers are just examples and can be freely deleted. You can also use them as references and a base for your own layers.

The first thing you need to do is to edit the modInfo at the top of game.js to set your modID (a string). A unique modId will prevent your mod's saves from conflicting with other mods.

Most of the time, you won't need to dive deep into the code to create things, but you still can if you really want to.

The Modding Tree uses break_eternity.js to store large values. This means that many numbers are Decimal objects, and must be treated differently. For example, you have to use new Decimal(x) to create a Decimal value instead of a plain number, and perform operations on them by calling functions. e.g, instead of x = x + y, use x = x.add(y).

Almost all values can be either a constant value, or a dynamic value. Dynamic values are defined by putting a function that returns what the value should be at any given time.

All display text can be basic HTML instead (But you can't use most Vue features there).

Table of Contents: ​

General: ​

  • Getting Started: Getting your own copy of the code set up with Github Desktop.
  • Main mod info: How to set up general things for your mod in mod.js.
  • Basic layer breakdown: Breaking down the components of a layer with minimal features.
  • Layer features: Explanations of all of the different properties that you can give a layer.
  • Custom Tab Layouts: An optional way to give your tabs a different layout. You can even create entirely new components to use.
  • Updating TMT: Using Github Desktop to update your mod's version of TMT.

Common components ​

  • Upgrades: How to create upgrades for a layer.
  • Milestones: How to create milestones for a layer.
  • Buyables: Create rebuyable upgrades for your layer (with the option to make them respec-able). Can be used to make Enhancers or Space Buildings.
  • Clickables: A more generalized variant of buyables, for any kind of thing that is sometimes clickable. Between these and Buyables, you can do just about anything.

Other components ​

  • Challenges: How to create challenges for a layer.
  • Bars: Display some information as a progress bar, gague, or similar. They are highly customizable, and can be horizontal and vertical as well.
  • Subtabs and Microtabs: Create subtabs for your tabs, as well as "microtab" components that you can put inside the tabs.
  • Achievements: How to create achievements for a layer (or for the whole game).
  • Infoboxes: Boxes containing text that can be shown or hidden.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/achievements.html b/public/gamedevtree/docs/achievements.html index 02f8b7c8..05931bcf 100644 --- a/public/gamedevtree/docs/achievements.html +++ b/public/gamedevtree/docs/achievements.html @@ -42,7 +42,7 @@ } etc }

Each achievement should have an id where the first digit is the row and the second digit is the column. Individual achievement can have these features:

  • name: optional, displayed at the top of the achievement. The only visible text. It can also be a function that returns updating text. Can use basic HTML.

  • done(): A function returning a boolean to determine if the achievement should be awarded.

  • tooltip: Default tooltip for the achievement, appears when it is hovered over. Should convey the goal and any reward for completing the achievement. It can also be a function that returns updating text. Can use basic HTML.

  • effect(): optional, A function that calculates and returns the current values of any bonuses from the achievement. Can return a value or an object containing multiple values.

  • unlocked(): optional, A function returning a bool to determine if the achievement is visible or not. Default is unlocked.

  • onComplete() - optional, this function will be called when the achievement is completed.

  • style: Optional, Applies CSS to this achievement, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings)

  • layer: Assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: Assigned automagically. It's the "key" which the achievement was stored under, for convenient access. The achievement in the example's id is 11.

  • goalTooltip: optional, depracated Appears when the achievement is hovered over and locked, overrides the basic tooltip. This is to display the goal (or a hint). It can also be a function that returns updating text. Can use basic HTML.

  • doneTooltip: optional, depracated Appears when the achievement is hovered over and completed, overrides the basic tooltip. This can display what the player achieved (the goal), and the rewards, if any. It can also be a function that returns updating text. Can use basic HTML.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/bars.html b/public/gamedevtree/docs/bars.html index 596fbe19..d57977d3 100644 --- a/public/gamedevtree/docs/bars.html +++ b/public/gamedevtree/docs/bars.html @@ -38,7 +38,7 @@ } etc }

Features:

  • direction: UP, DOWN, LEFT, or RIGHT (not Strings). Determines the direction that the bar is filled as it progresses. RIGHT means from left to right.

  • width, height: The size in pixels of the bar, but as Numbers (no "px" at the end)

  • progress(): A function that returns the portion of the bar that is filled, from "empty" at 0 to "full" at 1. (Nothing bad happens if the value goes out of these bounds, and it can be a number or Decimal).

  • display(): optional, A function that returns text to be displayed on top of the bar, can use HTML.

  • unlocked(): optional, A function returning a bool to determine if the bar is visible or not. Default is unlocked.

  • baseStyle, fillStyle, borderStyle, textStyle: Optional, Apply CSS to the unfilled portion, filled portion, border, and display text on the bar, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: Assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: Assigned automagically. It's the "key" which the bar was stored under, for convenient access. The bar in the example's id is "bigBar".

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/basic-layer-breakdown.html b/public/gamedevtree/docs/basic-layer-breakdown.html index 9cd3a128..df1cfcba 100644 --- a/public/gamedevtree/docs/basic-layer-breakdown.html +++ b/public/gamedevtree/docs/basic-layer-breakdown.html @@ -80,7 +80,7 @@ layerShown() {return true}, // Returns a bool for if this layer's node should be visible in the tree. },

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/buyables.html b/public/gamedevtree/docs/buyables.html index 5f9100cb..c9ca48fa 100644 --- a/public/gamedevtree/docs/buyables.html +++ b/public/gamedevtree/docs/buyables.html @@ -52,7 +52,7 @@ } etc }

Features:

  • title: optional, displayed at the top in a larger font It can also be a function that returns updating text.

  • cost(): cost for buying the next buyable. Can have an optional argument "x" to calculate the cost of the x+1th object, but needs to use "current amount" as a default value for x. (x is a Decimal). Can return an object if there are multiple currencies.

  • effect(): optional, A function that calculates and returns the current values of bonuses of this buyable. Can return a value or an object containing multiple values.

  • display(): A function returning everything that should be displayed on the buyable after the title, likely including the description, amount bought, cost, and current effect. Can use basic HTML.

  • unlocked(): optional, A function returning a bool to determine if the buyable is visible or not. Default is unlocked.

  • canAfford(): A function returning a bool to determine if you can buy one of the buyables.

  • buy(): A function that implements buying one of the buyable, including spending the currency.

  • buyMax(): optional, A function that implements buying as many of the buyable as possible.

  • style: Optional, Applies CSS to this buyable, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings)

  • layer: Assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: Assigned automagically. It's the "key" which the buyable was stored under, for convenient access. The buyable in the example's id is 11.

Sell One/Sell All:

Including a sellOne or sellAll function will cause an additional button to appear beneath the buyable. They are functionally identical, but "sell one" appears above "sell all". You can also use them for other things.

sellOne/sellAll(): optional, Called when the button is pressed. The standard use would be to decrease/reset the amount of the buyable, And possibly return some currency to the player.

canSellOne/canSellAll(): optional, booleans determining whether or not to show the buttons. If "canSellOne/All" is absent but "sellOne/All" is present, the appropriate button will always show.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/challenges.html b/public/gamedevtree/docs/challenges.html index 547fef68..5384b4a5 100644 --- a/public/gamedevtree/docs/challenges.html +++ b/public/gamedevtree/docs/challenges.html @@ -42,7 +42,7 @@ } etc }

Each challenge should have an id where the first digit is the row and the second digit is the column. Individual Challenges can have these features:

  • name: Name of the challenge, can be a string or a function. Can use basic HTML.

  • challengeDescription: A description of what makes the challenge a challenge. You will need to implement these elsewhere It can also be a function that returns updating text. Can use basic HTML.

  • rewardDescription: A description of the reward's effect. You will also have to implement the effect where it is applied. It can also be a function that returns updating text. Can use basic HTML.

  • rewardEffect(): optional, A function that calculates and returns the current values of any bonuses from the reward. Can return a value or an object containing multiple values. Can use basic HTML.

  • rewardDisplay(): optional, A function that returns a display of the current effects of the reward with formatting. Default behavior is to just display the a number appropriately formatted.

  • goal: A Decimal for the amount of currency required to beat the challenge. By default, the goal is in basic Points. The goal can also be a function if its value changes.

  • unlocked(): optional, A function returning a bool to determine if the challenge is visible or not. Default is unlocked.

  • onComplete() - optional, this function will be called when the challenge is completed when previously incomplete.

  • countsAs: optional, If a challenge combines the effects of other challenges in this layer, you can use this. An array of challenge ids. The player is effectively in all of those challenges when in the current one.

By default, challenges use basic Points for the goal. You can change that using these features.

  • currencyDisplayName: optional, the name to display for the currency for the goal

  • currencyInternalName: optional, the internal name for that currency

  • currencyLayer: optional, the internal name of the layer that currency is stored in. If it's not in a layer, omit. If it's not stored directly in a layer, instead use the next feature.

  • currencyLocation: optional, if your currency is stored in something inside a layer (e.g. a buyable's amount), you can access it this way. This is a function returning the object in "player" that contains the value (like player[this.layer].buyables)

  • completionLimit: optional, the amount of times you can complete this challenge. Default is 1 completion.

  • style: Optional, Applies CSS to this challenge, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings)

  • layer: Assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: Assigned automagically. It's the "key" which the challenge was stored under, for convenient access. The challenge in the example's id is 11.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/clickables.html b/public/gamedevtree/docs/clickables.html index d2c628c3..6896e311 100644 --- a/public/gamedevtree/docs/clickables.html +++ b/public/gamedevtree/docs/clickables.html @@ -50,7 +50,7 @@ } etc }

Features:

  • title: optional, displayed at the top in a larger font It can also be a function that returns updating text.

  • effect(): optional, A function that calculates and returns the current values of bonuses of this clickable. Can return a value or an object containing multiple values.

  • display(): A function returning everything that should be displayed on the clickable after the title, likely changing based on its state. Can use basic HTML.

  • unlocked(): optional, A function returning a bool to determine if the clickable is visible or not. Default is unlocked.

  • canClick(): A function returning a bool to determine if you can click the clickable.

  • onClick(): A function that implements clicking one of the clickable.

  • style: Optional, Applies CSS to this clickable, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings)

  • layer: Assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: Assigned automagically. It's the "key" which the clickable was stored under, for convenient access. The clickable in the example's id is 11.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/custom-tab-layouts.html b/public/gamedevtree/docs/custom-tab-layouts.html index 5e108a8f..12edc04a 100644 --- a/public/gamedevtree/docs/custom-tab-layouts.html +++ b/public/gamedevtree/docs/custom-tab-layouts.html @@ -42,7 +42,7 @@ "blank", ["toggle", ["c", "beep"]], "milestones", "blank", "blank", "upgrades"]

It is a list of components, which can be either just a name, or an array with arguments. If it's an array, the first item is the name of the component, the second is the data passed into it, and the third (optional) applies a CSS style to it with a "CSS object", where the keys are CSS attributes.

These are the existing components, but you can create more in v.js:

  • display-text: Displays some text (can use basic HTML). The argument is the text to display. It can also be a function that returns updating text.

  • raw-html: Displays some basic HTML, can also be a function.

  • blank: Adds empty space. The default dimensions are 8px x 17px. The argument changes the dimensions. If it's a single value (e.g. "20px"), that determines the height. If you have a pair of arguments, the first is width and the second is height.

  • row: Display a list of components horizontally. The argument is an array of components in the tab layout format.

  • column: Display a list of components vertically. The argument is an array of components in the tab layout format. This is useful to display columns within a row.

  • main-display: The text that displays the main currency for the layer and its effects.

  • resource-display: The text that displays the currency that this layer is based on, as well as the best and/or total values for this layer's prestige currency (if they are put in startData for this layer)

  • prestige-button: The argument is a string that the prestige button should say before the amount of currency you will gain. It can also be a function that returns updating text.

  • upgrades, milestones, challs, achievements: Display the upgrades, milestones, and challenges for a layer, as appropriate.

  • buyables, clickables: Display all of the buyables/clickables for this layer, as appropriate. The argument optional, and is the size of the boxes in pixels.

  • microtabs: Display a set of subtabs for an area. The argument is the name of the set of microtabs in the "microtabs" feature.

  • bar: Display a bar. The argument is the id of the bar to display.

  • infobox: Display an infobox. The argument is the id of the infobox to display.

  • toggle: A toggle button that toggles a bool value. The data is a pair that identifies what bool to toggle, [layer, id]

The rest of the components are sub-components. They can be used just like other components, but are typically part of another component.

  • upgrade, milestone, chall, buyable, clickable, achievement: An individual upgrade, challenge, etc. The argument is the id. This can be used if you want to have upgrades split up across multiple subtabs, for example.

  • respec-button, master-button: The respec and master buttons for buyables and clickables, respectively.

  • sell-one, sell-all: The "sell one" and "sell all" for buyables, respectively. The argument is the id of the buyable.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/getting-started.html b/public/gamedevtree/docs/getting-started.html index fc8807c3..bcfa2243 100644 --- a/public/gamedevtree/docs/getting-started.html +++ b/public/gamedevtree/docs/getting-started.html @@ -26,7 +26,7 @@

Appearance

Getting started ​

Welcome to The Modding Tree!

Using the Modding Tree, at its simplest level, just requires getting a copy of it onto your computer. However, if you do it the right way, it will help in many ways.

Don't let the word "Github" scare you away. It's actually much easier to use than most people think, especially because most people use it the hard way. The key is Github Desktop, which lets you do everything you need to, without even touching the command line.

The benefits of using Github:

  • It makes it much, much easier to update The Modding Tree.
  • You can share your work without any extra effort using githack, or with a bit more effort, set up a github.io site.
  • It lets you undo changes to your code, and to have multiple versions of it.
  • It lets you collaborate with other people, if you want to.

Getting set up with Github and The Modding Tree: ​

  1. Install Github Desktop and Visual Studio Code.

  2. Make a Github account. You can handle this on your own.

  3. Log in on your browser, and go back to The Modding Tree page. At the top right, there should be a button that says "fork". Click on it, and then on your username. You now have your own fork, or copy, of The Modding Tree.

  4. Open Github Desktop and log in. Ignore everything else and choose "clone a repository". A "repository" is basically a "Github project", like The Modding Tree. "Cloning" is downloading a copy of the repository to your computer.

  5. Look for The Modding Tree in the list of repositiories (it should be the only one) and click "clone".

  6. Select that you're using it for your own purposes, and click continue. It will download the files and handle everything.

Using your repository ​

  1. Click on "show in finder" to the right, and then open index.html. This will let you view and test your project!

  2. To edit your project, click "open in VSCode" in Github Desktop.

  3. Open mod.js in VSCode, and look at the top part where it says "modInfo". On the lines below that, change the mod's name to whatever you want, and change the id as well. (It can be any string value, and it's used to determine where the savefile is. Make it something that's probably unique, and don't change it again later.)

  4. Save game.js, and then reload index.html. The title on the tab, as well as on the info page, will now be the new ones!

  5. Go back to Github Desktop. It's time to save your changes into the git system by making a "commit".

  6. At the bottom right corner, add a summary of your changes, and then click "commit to master".

  7. Finally, at the top middle, click "push origin" to push your changes out onto the online repository.

  8. You can view your project on line, or share it with others, by going to https://raw.githack.com/[YOUR-GITHUB-USERNAME]/The-Modding-Tree/master/index.html

And now, you have successfully used Github! You can look at the documentation to see how The Modding Tree's system works and to make your mod a reality.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/infoboxes.html b/public/gamedevtree/docs/infoboxes.html index a1469319..8de047dc 100644 --- a/public/gamedevtree/docs/infoboxes.html +++ b/public/gamedevtree/docs/infoboxes.html @@ -38,7 +38,7 @@ } etc }

Features:

  • title: The text displayed above the main box. Can be a function to be dynamic, and can use basic HTML.

  • body: The text displayed inside the box. Can be a function to be dynamic, and can use basic HTML.

  • style, titleStyle, bodyStyle: Optional, Apply CSS to the infobox, or to the title button or body of the infobox, in the form of an object where the keys are CSS attributes, and the values are the Values for those attributes (both as strings).

  • unlocked(): optional, A function returning a bool to determine if the infobox is visible or not. Default is unlocked.

  • layer: Assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: Assigned automagically. It's the "key" which the bar was stored under, for convenient access. The bar in the example's id is "bigBar".

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/layer-features.html b/public/gamedevtree/docs/layer-features.html index 57303afc..0b18c9f4 100644 --- a/public/gamedevtree/docs/layer-features.html +++ b/public/gamedevtree/docs/layer-features.html @@ -48,7 +48,7 @@ "challenge"() {return {'height': '200px'}}, "prestige-button"() {return {'color': '#AA66AA'}}, },

Custom Prestige type ​

  • getResetGain(): For custom prestige type, Returns how many points you should get if you reset now. You can call getResetGain(this.layer, useType = "static") or similar to calculate what your gain would be under another prestige type (provided you have all of the required features in the layer.)

  • getNextAt(canMax=false): For custom prestige type, Returns how many of the base currency you need to get to the next point. canMax is an optional variable used with Static-ish layers to differentiate between if it's looking for the first point you can reset at, or the requirement for any gain at all. (Supporting both is good). You can also call getNextAt(this.layer, canMax=false, useType = "static") or similar to calculate what your next at would be under another prestige type (provided you have all of the required features in the layer.)

  • canReset(): For custom prestige type, return true only if you have the resources required to do a prestige here.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/main-mod-info.html b/public/gamedevtree/docs/main-mod-info.html index c03d27f5..9a5d57f5 100644 --- a/public/gamedevtree/docs/main-mod-info.html +++ b/public/gamedevtree/docs/main-mod-info.html @@ -34,7 +34,7 @@ weather: "Yes", happiness: new Decimal(72), }}

  • displayThings: An array of functions used to display extra things at the top of the tree tab. Each function returns a string, which is a line to display (with basic HTML support). If a function returns nothing, nothing is displayed (and it doesn't take up a line).

  • isEndgame(): A function to determine if the player has reached the end of the game, at which point the "you win!" screen appears.

Less important things beyond this point!

  • maxTickLength(): Returns the maximum tick length, in milliseconds. Only really useful if you have something that reduces over time, which long ticks mess up (usually a challenge).

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/milestones.html b/public/gamedevtree/docs/milestones.html index ed5e254b..f5bf33fa 100644 --- a/public/gamedevtree/docs/milestones.html +++ b/public/gamedevtree/docs/milestones.html @@ -37,7 +37,7 @@ etc }

You can use hasMilestone(layer, id) to determine if the player has a given milestone

Milestone features:

  • requirementDesc: A string describing the requirement for unlocking this milestone. Suggestion: Use a "total". It can also be a function that returns updating text. Can use basic HTML.

  • effectDesc: A string describing the reward for having the milestone. You will have to implement the reward elsewhere. It can also be a function that returns updating text. Can use basic HTML.

  • done(): A function returning a boolean to determine if the milestone should be awarded.

  • toggles: optional, Creates toggle buttons that appear on the milestone when it is unlocked. The toggles can toggle a given boolean value in a layer. It is defined as an array of paired items, one pair per toggle. The first is the internal name of the layer the value being toggled is stored in, and the second is the internal name of the variable to toggle. (e.g. [["b", "auto"], ["g", "auto"])

         **Tip:** Toggles are not de-set if the milestone becomes locked! In this case, you should also check if the player has the milestone.

  • style: Optional, Applies CSS to this milestone, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings)

  • unlocked(): Optional A function returning a boolean to determine if the milestone should be shown. If absent, it is always shown.

  • layer: Assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: Assigned automagically. It's the "key" which the milestone was stored under, for convenient access. The milestone in the example's id is 0.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/subtabs-and-microtabs.html b/public/gamedevtree/docs/subtabs-and-microtabs.html index 4c6e101e..fb12988f 100644 --- a/public/gamedevtree/docs/subtabs-and-microtabs.html +++ b/public/gamedevtree/docs/subtabs-and-microtabs.html @@ -70,7 +70,7 @@ // There could be another set of microtabs here } },

Normal subtabs and microtab subtabs both use the same features:

Features: ​

  • content: The tab layout code for the subtab, in the tab layout format

  • style: Optional, Applies CSS to the whole subtab when switched to, in the form of an "CSS Object", where the keys are CSS attributes, and the values are the values for those attributes (both as strings)

  • buttonStyle: Optional, A CSS object, which affects the appearance of the button for that subtab.

  • unlocked(): Optional, a function to determine if the button for this subtab should be visible. By default, a subtab is always unlocked. (You can't use the "this" keyword in this function.)

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/updating-tmt.html b/public/gamedevtree/docs/updating-tmt.html index 34443b09..c1d6d5fa 100644 --- a/public/gamedevtree/docs/updating-tmt.html +++ b/public/gamedevtree/docs/updating-tmt.html @@ -26,7 +26,7 @@

Appearance

Updating The Modding Tree ​

This tutorial assumes that you have used the Getting Started Tutorial, and are using Github Desktop and VSCode for your mod.

Here's what you have to do when there's a TMT update:

  1. Look at the changelog. It will warn you if the update will break anything or require any changes. Decide if you want to try to update.

  2. Open Github Desktop, and at the top middle, click "fetch origin". This will make Github Desktop get information about the update.

  3. Click where it says "current branch: master" at the top middle, and at the bottom of the thing that appears, click "choose a branch to merge into master.

  4. Select upstream/master. It will likely say there are conflicts, but you have tools to resolve them. Click "Merge upstream/master into master".

  5. A conflict happens when the things you're trying to merge have both made changes in the same place. Click "open in Visual Studio Code" next to the first file.

  6. Scroll down through the file, and look for the parts highlighted in red and green. One of these is your code, and the other is some code that will be modified by the update. Do your best to try to edit things to keep the updated changes, but keep your content.

  7. Continue to do this for all remaining challenges.

  8. Do any other changes required by the update, run the game, fix issues, etc.

Last updated:

- + \ No newline at end of file diff --git a/public/gamedevtree/docs/upgrades.html b/public/gamedevtree/docs/upgrades.html index afabe056..d8e812bb 100644 --- a/public/gamedevtree/docs/upgrades.html +++ b/public/gamedevtree/docs/upgrades.html @@ -42,7 +42,7 @@ } etc }

Each upgrade should have an id where the first digit is the row and the second digit is the column. Individual upgrades can have these features:

  • title: optional, displayed at the top in a larger font It can also be a function that returns updating text. Can use basic HTML.

  • description: A description of the upgrade's effect. You will also have to implement the effect where it is applied. It can also be a function that returns updating text. Can use basic HTML.

  • effect(): optional, A function that calculates and returns the current values of any bonuses from the upgrade. Can return a value or an object containing multiple values.

  • effectDisplay(): optional, A function that returns a display of the current effects of the upgrade with formatting. Default behavior is to just display the a number appropriately formatted. Can use basic HTML.

  • cost: A Decimal for the cost of the upgrade. By default, upgrades cost the main prestige currency for the layer.

  • unlocked(): optional, A function returning a bool to determine if the upgrade is visible or not. Default is unlocked.

  • onPurchase() - optional, this function will be called when the upgrade is purchased. Good for upgrades like "makes this layer act like it was unlocked first".

By default, upgrades use the main prestige currency for the layer. You can include these to change them (but it needs to be a Decimal):

  • currencyDisplayName: optional, the name to display for the currency for the upgrade

  • currencyInternalName: optional, the internal name for that currency

  • currencyLayer: optional, the internal name of the layer that currency is stored in. If it's not in a layer (like Points), omit. If it's not stored directly in a layer, instead use the next feature.

  • currencyLocation: optional, if your currency is stored in something inside a layer (e.g. a buyable's amount), you can access it this way. This is a function returning the object in "player" that contains the value (like player[this.layer].buyables)

  • style: Optional, Applies CSS to this upgrade, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings)

  • layer: Assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: Assigned automagically. It's the "key" which the upgrade was stored under, for convenient access. The upgrade in the example's id is 11.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/Old Things/2.0-format-changes.html b/public/kronos/Old Things/2.0-format-changes.html index 59347b89..64e40e58 100644 --- a/public/kronos/Old Things/2.0-format-changes.html +++ b/public/kronos/Old Things/2.0-format-changes.html @@ -26,7 +26,7 @@

Appearance

2.0 format changes ​

  • Temp format is changed from temp.something[layer] to temp[layer].something, for consistency
  • Challenges are now saved as an object with the amount of completions in each spot. (This will break saves.)
  • effectDisplay in Challenges and Upgrades no longer takes an argument, and neither does effect for Buyables
  • Buyable cost can take an argument for amount of buyables, but it needs to function if no argument is supplied (it should do the cost for the next purchase).
  • Generation of Points now happens in the main game loop (not in a layer update function), enabled by canGenPoints in game.js.
  • Changed fullLayerReset to layerDataReset, which takes an array of names of values to keep

In addition, many names were changed, mostly expanding abbreviations:

All instances of:

  • chall -> challenge
  • unl -> unlocked
  • upg -> upgrade (besides CSS)
  • amt -> amount
  • desc -> description
  • resCeil -> roundUpCost
  • order -> unlockOrder
  • incr_order -> increaseUnlockOrder

Challenges:

  • desc -> challengeDescription
  • reward -> rewardDescription
  • effect -> rewardEffect
  • effectDisplay -> rewardDisplay
  • active -> challengeActive

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/README.html b/public/kronos/README.html index dcae9178..8093c6aa 100644 --- a/public/kronos/README.html +++ b/public/kronos/README.html @@ -26,7 +26,7 @@

Appearance

Kronos ​

Play here.

Updating the website:

  • git submodule update --remote
  • git add -A
  • git commit -m "Updated kronos"
  • git push

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/changelog.html b/public/kronos/changelog.html index 1d6bbcde..aff36a6f 100644 --- a/public/kronos/changelog.html +++ b/public/kronos/changelog.html @@ -26,7 +26,7 @@

Appearance

The Modding Tree changelog: ​

v2.5.9.2 - 5/19/21 ​

  • Fixed many issues with things not updating.

v2.5.9.1 - 5/18/21 ​

  • Made text inputs never give NaNs.

v2.5.9 - 5/18/21 ​

  • Fixed issue when using text inputs for Numbers.
  • Added particle color feature.
  • Particle speed and dir are updated as it moves.
  • Added setSpeed and setDir for particles.
  • Added more trig functions.

v2.5.8 - 5/17/21 ​

  • Added makeShinies, which creates a stationary particle in a random spot.
  • Bars will visually update more quickly.
  • Fixed a major particle-related issue.
  • Fixed autoUpgrade.
  • Fixed a minor visual issue with tree nodes.

v2.5.7 - 5/15/21 ​

  • Added a particle system! Not only can it be used for visual effects, but particles can interact with the mouse. They could be used to create golden cookies or collectables, for example.
  • Added marked feature to buyables, clickables, and challenges. By default, stars multi-completion challenges when maxed.
  • Added 'deactivated' feature to layers, which disables many features.
  • Improved number formatting slightly.

v2.5.6 - 5/14/21 ​

  • You can now use non-numeric ids for upgrades, buyables, etc.
  • Fixed an exploit that let you buy an extra buyable.
  • Moved basic getter/setter functions to easyAccess.js.

v2.5.5.2 - 5/12/21 ​

  • Fixed a major issue with buyables.
  • Fixed a variety of tabFormat-related issues.
  • Fixed commas appearing in decimal places (thanks to pg132!)

v2.5.5.1 - 5/12/21 ​

  • Fixed clickables.

v2.5.5 - 5/12/21 ​

  • Added grids! They are a grid of buttons which behave the same, but have their own data. Good for inventory grids, map tiles, and more!
  • Added "marked" feature to add a mark to a node. Can be an image instead of a star. (Originally by Jacorb)
  • Added "layer-proxy" component that lets you use components from another layer.
  • Added the ability to display non-whole numbers in main-display.

v2.5.4 - 5/10/21 ​

  • Added a setting to always use single-tab mode.
  • Added directMult, which multiplies prestige gain after exponents and softcaps. It actually multiplies gain for static layers.
  • Added onEnter and onExit for challenges.
  • Improved displaying numbers between 0.0001 and 0.1.
  • Added documentation on how gainMult/Exp work for static layers.
  • Fixed a visual issue on mobile, thanks to thepaperpilot.
  • Improved documentation in general.

v2.5.3 - 5/8/21 ​

  • Improved performance of tab formats and bars.
  • Respec confirmation settings are now kept on resets.
  • Improved compatibility with older browsers.
  • Fixed missing pixel on vertical bars.

v2.5.2.1 - 5/7/21 ​

  • Fixed microtabs making layers highlight incorrectly.

v2.5.2 - 5/7/21 ​

  • Added glowColor for subtabs.
  • Improved the display for extremely small numbers.
  • Fixed issues in the buyable docs.

v2.5.1 - 5/7/21 ​

  • Fixed dynamic things in tabFormat not updating.

v2.5: Dreams Really Do Come True - 5/7/21 ​

  • Optimizations, hopefully a significant amount.
  • Added OOM/s point gen display at high values (thanks to Ducdat!)
  • Only one tab will display if the window is not wide enough (also thanks to Ducdat!)
  • Holding down a buyable's button now buys it continuously.
  • New milestone setting will also show the most recently unlocked milestone. (Also renamed all settings to be clearer)
  • Added an onHold feature for clickables.
  • Layer nodes will be highlighted even if the player is on the same tab.
  • Added customizable node glowColor.
  • Added buyable purchaseLimit.
  • Amount is automatically supplied to buyable cost and effect functions.
  • Locked (not yet visible) milestones no longer take up space. Also fixed hidden milestones taking a tiny bit of space.
  • Re-centered respec buttons.
  • Force-displayed tooltips are not hidden by resets.
  • Added formatting support for very small numbers. Disabled in most places by default because rounding errors might cause issues. Access it with formatSmall, or enable it globally by adding "allowSmall: true" to modInfo.

v2.4.1 - 4/29/21 ​

  • A number of minor fixes, many thanks to thepaperpilot.
  • The respec confirmation checkbox is now part of the respec-button component. (This also fixes the checkbox appearing when there is no respec button)
  • Added a few undocumented changes to the 2.4 changelog (the two at the bottom)

v2.4: Rationalized Edition - 4/29/21 ​

  • Completely reworked tooltips. Shift-click a node to force its tooltip to stay displayed. (And hopefully finally fixed flickering!)

  • Added text-input and slider components.

  • Added the ability to toggle respec confirmations.

  • Added custom respec confirmation messages.

  • The red layer highlight will not appear before a layer is unlocked.

  • Added unlocking hotkeys.

  • You no longer need to supply 'rows' and 'cols' for any Big Features.

  • Node symbols can use HTML.

  • Added documentation for the respec button.

  • Added prestigeNotify to subtabs, and prestigeNotify in subtabs also highlights the layer node.

  • The version number no longer contains special characters or irrational numbers.

  • Added ctrlDown and shiftDown variables.

  • Tooltips now use HTML (this means you need to replace any newlines with
    )

v2.π.1 - 4/7/21 ​

  • Fixed formatting for some larger numbers.
  • Upgrades will expand if there is too much text to display.
  • Fixed styling challenges.
  • No longer attempts to display a base currency when there is none.

v2.π: Incrementally Updated - 2/5/21 ​

  • Performance improvements.
  • Fixed tooltips overlapping with the top display.
  • Clicking a popup dismisses it immediately.
  • Added support for bulk challenge completions.
  • "Best" is updated automatically.
  • Fixed keeping Decimal values on reset.
  • Code reorganization and style improvements by fudo.

v2.3.5 - 12/21/20 ​

  • Added resetTime, which tracks the time since a layer prestiged or was reset.
  • A layer node will be highlighted red if one of its subtabs is highlighted red.
  • Fixed issues with keeping challenges, buyables, and clickables on reset.
  • Improved the unlocking of custom layers.
  • Other minor fixes.

v2.3.4 - 12/16/20 ​

  • Added a node image feature.
  • Resource display now always shows the amount of the currency the layer's gain is based on.
  • Added spacing between tree nodes.
  • Another attempt to fix tooltip flickering.

v2.3.3 - 12/13/20 ​

  • Fixed the first node in a row always taking up space.
  • layerShown is now optional.
  • All prestige types can now use features for custom prestige types.

v2.3.2 - 12/13/20 ​

  • Fixed achievement/milestone popups.

v2.3.1 - 12/12/20 ​

  • Another attempt to fix flickering tooltips.
  • The "this" keyword should work everywhere except tabFormat arrays (although I may have missed some things).
  • Fixed tree branches not updating when scrolling on the right-side tab.
  • Fixed a spacing issue when a node's symbol is ""
  • Removed some old, unneeded files.

v2.3: Cooler and Newer Edition - 12/10/20 ​

  • Added achievement/milestone popups (thank you to Jacorb for this contribution!)
  • The changelog tab is back, and can be set in mod.js.
  • Layer nodes and respec buttons will not be clicked by pressing "enter".
  • Possible fix for flickering tooltips and strange transitions.
  • The victory screen text is configurable.
  • Added image and textStyle features to achievements.
  • Added an argument to use specific rows in an "upgrades" component.
  • Fixed the comma appearing in the main display when there was no effectDescription
  • Added the ability to easily make a tab that is a collection of layers in subtabs.
  • Improved spacing for embedding layers with subtabs into subtabs.

v2.2.8 - 12/03/20 ​

  • Double-clicking a layer node brings you to the main subtab for that layer.
  • Attempted to fix challenges visually updating a different way.
  • Added a softcap function for use in formulas.
  • Added displayRow feature, which lets layers be shown somewhere separate from where they are in the reset order (e.g. side layers)
  • Fixed autoupgrade issue.

v2.2.7 - 11/30/20 ​

  • Added autoUpgrade feature.
  • resource-display now shows resource gain per second if passiveGain is active.
  • Fixed formatting issues on some large numbers.
  • Better support for using classed objects in player and in layers/tmp.
  • Made hard resetting more effective.
  • Removed Herobrine from getStartClickables.

v2.2.6 - 11/30/20 ​

  • Added goalDescription for challenges and made the new "canComplete" system the standard.
  • Another attempt to fix challenges not visually updating.
  • Fixed side layers not appearing.
  • Fixed getStartClickables again.

v2.2.5 - 11/29/20 ​

  • Added features for overriding the displays and costs/goals of upgrades and challenges to make them fully custom.
  • best, total, and unlocked are always automatically added to layerData (but best and total will only display if you add them yourself).
  • Fixed getStartClickables.

v2.2.4 - 11/28/20 ​

  • Added softcap and softcapPower features (for Normal layers)
  • Offline time limit and default max tick length were fixed (previously the limits were 1000x too large)
  • Added fixOldSaves.
  • You can use HTML in main-display.
  • Fixed a number of minor oddities.

v2.2.3 - 11/28/20 ​

  • Layers will be highlighted if you can finish a challenge.
  • The "can complete challenge" color now overrides the "already completed" color.
  • Button nodes now work as side "layers".
  • Setting a tooltip to "" hides it entirely.

v2.2.2 - 11/22/20 ​

  • Fixed right half of the screen being unclickable in some circumstances.
  • Fixed tree branches being offset.
  • Fix to lastSafeTab.

v2.2.1 - 11/7/20 ​

  • Added a small highlight to layers you can meaningfully prestige on.
  • Added passiveGeneration and autoPrestige features to standardize prestige automation. (The old ways still work, but the new ones work better with other things)
  • Improved milestones visually a bit.
  • "best" and "total" are now only displayed if present in startData.
  • Fixed issues with things not updating visually. (Thank you to to Jacorb!)
  • Side layers and button nodes can now be highlighted.
  • Updated docs on the new tree-related features.

v2.2: Uprooted - 11/7/20 ​

  • You can now embed a layer inside of a subtab or microtab!
  • Added support for hiding or reformatting the tree tab
  • Added non-layer button nodes
  • Added shouldNotify to subtab/microtab buttons. (You can make them highlighted)
  • Added commas to large exponents.
  • Upgrades now only show "currently" if they have an effectDisplay (so not for constant effects).
  • Achievements are part of the default tab format.
  • NaN is now handled more intelligently.
  • Renamed files, and moved less relevant ones to another folder.
  • The "hide completed challenges" setting now only hides challenges at max completions.
  • Thank you to thepaperpilot for fixing errors in docs and improving the infobox appearance!
  • Many other minor fixes.

v2.1.4 - 10/25/20 ​

  • Added an infobox component. Thank you to thepaperpilot for this contribution!
  • Layer type is now optional, and defaults to "none".
  • Improved the look of bars and tab buttons.
  • Improved spacing between layer nodes (also thanks to thepaperpilot!)
  • Fixed the "blank" component breaking if only specifying the height.
  • Fixed some numbers not displaying with enough digits.
  • Made a few more things able to be functions.
  • A few other minor fixes.

v2.1.3.1 - 10/21/20 ​

  • Fixed the update function.

v2.1.3 - 10/21/20 ​

  • gainMult and gainExp are now optional.
  • Layer unlocking is now kept on reset.
  • Game should start up faster.
  • Layer updates now have a determined order and starts with earlier-rowed layers.
  • Automation now has a determined order and starts with later-rowed layers.
  • Fixed issues with resetting clickables and challenges.
  • Commas should no longer appear in the decimal places of a number.
  • Fixed potential issue in displaying the tree.

v2.1.2 - 10/19/20 ​

  • Added buyUpgrade function (buyUpg still works though)
  • Added author name to modInfo.
  • Fix to crash caused when the name of a subtab or microtab is changed.
  • Fixes to outdated information in docs.
  • Improvements to Discord links.
  • Thank you to thepaperpilot for contributing to this update!

v2.1.1 - 10/17/20 ​

  • Added resource-display component, which displays the base currency for the prestige layer, as well as the best and/or total of this layer's prestige currency.
  • Fixed the value for the base currency not updating in resource-display.

v2.1: We should have thought of this sooner! - 10/17/20 ​

  • Moved most of the code users will want to edit to mod.js, added documentation for it.
    • Specifically, modInfo, VERSION, canGenPoints, getPointGen, and maxTickLength
  • Added getStartPoints()
  • Added the ability to store non-layer-related data
  • Added the ability to display more things at the top of the tree tab below points.
  • Made the endgame condition customizable
  • Added "sell one" and "sell all" buttons for buyables.
  • Moved the old "game" to demo.js, and replaced it with a minimal game that won't cause issues when edited.
  • Fixed issues with version number
  • Fixed number formatting issue making things like "10e9" appear.

v2.0.5 - 10/16/20 ​

  • Made more features (including prestige parameters) able to be dynamic.
  • Layer nodes can be hidden but still take up space with "ghost" visibility
  • Added clickableEffect for real.
  • Fixed some visual issues with bars.
  • A few other minor tweaks and improvements.

v2.0.4 - 10/16/20 ​

  • Fixed HTML on buttons interfering with clicking on them.

v2.0.3 - 10/16/20 ​

  • Fixed hotkeys not displaying in info.
  • Fixed the game supressing all external hotkeys.
  • You can use more things as currencies for upgrade costs and challenge goals using currencyLocation.
  • Added maxTickLength, which can be used to prevent offline time or tab-switching from breaking time-limit based mechanics.
  • Made buyable respec buttons and clickable "master" buttons their own components, and gave them a hide/show feature.
  • Added a general "tooltip" feature for achievements.

v2.0.2 - 10/15/20 ​

  • Branches are now dynamic (they can be functions).
  • Fixed a crash related to offline time.
  • Fixed links being too wide.

v2.0.1 - 10/15/20 ​

  • Fixed side layers appearing multiple times.

v2.0: The Pinnacle of Achievement Mountain - 10/15/20 ​

  • Added progress bars, which are highly customizable and can be horizontal or vertical!
  • Added "side layers", displayed smaller and off to the side, and don't get reset by default. They can be used for global achievements and statistics. Speaking of which...
  • Added achievements!
  • Added clickables, a more generalized variant of buyables.
  • Almost every value in layer data can be either a function or a constant value!
  • Added support for multiple completions of challenges.
  • Added "none" prestige type, which removes the need for any other prestige-related features.
  • The points display and other gui elements stay at the top of the screen when the tree scrolls.
  • Added getter/setter functions for the amounts and effects of most Big Features
  • Moved modInfo to game.js, added a spot in modInfo for a Discord link, changelog link. Also added a separate mod version from the TMT version in VERSION.
  • Tree structure is based on layer data, no index.html editing is needed.
  • Tmp does not need to be manually updated.
  • You don't have to have the same amount of upgrades in every row (and challs and buyables)
  • "unlocked" is optional for all Big Components (defaults to true).
  • All displays will update correctly.
  • Changelog is no longer in index.html at all.
  • Generation of Points now happens in the main game loop
  • Changed the reset functions to make keeping things easier
  • Renamed many things to increase readability (see the list in the link below)
  • Improved documentation based on feedback

v1.3.5: ​

  • Completely automated convertToDecimal, now you never have to worry about it again.
  • Branches can be defined without a color id. But they can also use hex values for color ids!
  • Created a tutorial for getting started with TMT and Github.
  • Page title is now automatically taken from mod name.

v1.3.4 - 10/8/20 ​

  • Added "midsection" feature to add things to a tab's layout while still keeping the standard layout.
  • Fix for being able to buy more buyables than you should.

v1.3.3 - 10/7/20 ​

  • Fix for the "order of operations" issue in temp.

v1.3.1 - 10/7/20 ​

  • Added custom CSS and tooltips for Layer Nodes.
  • Added custom CSS for upgrades, buyables, milestones, and challenges, both individually and layer-wide.
  • You can now use HTML in most display text!
  • You can now make milestones unlockable and not display immediately.
  • Fixed importing saves, and issue with upgrades not appearing, and probably more.
  • Optional "name" layer feature, used in confirmation messages.

v1.3: Tabception... ception! - 10/7/20 ​

  • Added subtabs! And also a Micro-tab component to let you make smaller subtab-esque areas anywhere.
  • Added a "custom" prestige formula type, and a number of features to support it.
  • Added points/sec display (can be disabled).
  • Added h-line, v-line and image-display components, plus components for individual upgrades, challenges, and milestones.
  • Added upgEffect, buyableEffect, and challEffect functions.
  • Added "hide completed challenges" setting.
  • Moved old changelogs to a separate place.
  • Fixed hasMilestone and incr_order.
  • Static layers now show the currency amount needed for the next one if you can buy max.

v1.2.4 - 10/4/20 ​

  • Layers are now highlighted if you can buy an upgrade, and a new feature, shouldNotify, lets you make it highlight other ways.
  • Fixed bugs with hasUpg, hasChall, hasMilestone, and inChallenge.
  • Changed the sample code to use the above functions for convenience.

v1.2.3 - 10/3/20 ​

  • Added a row component, which displays a list of objects in a row.
  • Added a column component, which displays a list of objects in a column (useful within a row).
  • Changed blanks to have a customizable width and height.

v1.2: This Changes Everything! - 10/3/20 ​

  • Many layer features can now be static values or functions. (This made some formats change, which will break old things)
  • You can now use the "this" keyword, to make code easier to transfer when making new layers.
  • Also added "this.layer", which is the current layer's name, and works on existing subfeatures (e.g. individual upgrades) as well! Subfeatures also have "this.id".
  • Fixed a big save issue. If you use a unique mod id, your save will never conflict with other mods.
  • Added a configurable offline time limit in modinfo at the top of index.html. (default 1 hour)
  • Added a few minor features, and updated the docs with new information.

v1.1.1 - 9/30/20 ​

  • You can define hotkeys directly from layer config.

v1.1: Enhanced Edition - 9/30/20 ​

  • Added "Buyables", which can function like Space Buildings or Enhancers.
  • Custom CSS can now be used on any component! Make the third argument an object with CSS parameters.
  • Lots of minor good things.

v1.0 - 9/27/20 ​

  • First release.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/!general-info.html b/public/kronos/docs/!general-info.html index 6b035150..6cfbd682 100644 --- a/public/kronos/docs/!general-info.html +++ b/public/kronos/docs/!general-info.html @@ -26,7 +26,7 @@

Appearance

The-Modding-Tree ​

Making a game in The Modding Tree mostly involves defining parameters or functions on objects. If you aren't following the getting started guide, you should start by setting up your basic mod info in mod.js. It's important to set a mod id to ensure saving works properly.

Beyond that, the main way to add content is through creating layers, often in layers.js. You can add new layers by calling addLayer(layername, layerdata). There is an example of a basic layer in layers.js showing the recommended method. It is just an example and can be freely deleted. You can also use it as a reference or a base for your own layers.

Most of the time, you won't need to dive deep into the code to create things, but you still can if you really want to, for example to add new Vue components in components.js.

The Modding Tree uses break_eternity.js to store large values. This means that many numbers are Decimal objects, and must be treated differently. For example, you have to use new Decimal(x) to create a Decimal value instead of a plain number, and perform operations on them by calling functions. e.g, instead of x = x + y, use x = x.add(y). Keep in mind this also applies to comparison operators, which should be replaced with calling the .gt, .gte, .lt, .lte, .eq, and .neq functions. See the break_eternity.js docs for more details on working with Decimal values.

Almost all values can be either a constant value, or a dynamic value. Dynamic values are defined by putting a function that returns what the value should be at any given time.

All display text can use basic HTML elements (But you can't use most Vue features there).

While reading this documentation, the following key will be used when describing features:

  • No label: This is required and the game may crash if it isn't included.
  • sometimes required: This is may be required, depending on other things in the layer.
  • optional: You can leave this out if you don't intend to use that feature for the layer.
  • assigned automagically: This value will be set automatically and override any value you set.
  • deprecated: This feature is not recommended to be used, because newer features are able to achieve the same thing in a better, easier way.

Table of Contents ​

General ​

  • Getting Started: Getting your own copy of the code set up with Github Desktop.
  • Main mod info: How to set up general things for your mod in mod.js.
  • Basic layer breakdown: Breaking down the components of a layer with minimal features.
  • Layer features: Explanations of all of the different properties that you can give a layer.
  • Custom Tab Layouts: An optional way to give your tabs a different layout. You can even create entirely new components to use.
  • Custom game layouts: You can get rid of the tree tab, add buttons and other things to the tree, or even customize the tab's layout like a layer tab.
  • Updating TMT: Using Github Desktop to update your mod's version of TMT.

Common components ​

  • Upgrades: How to create upgrades for a layer.
  • Milestones: How to create milestones for a layer.
  • Buyables: Create rebuyable upgrades for your layer (with the option to make them respec-able). Can be used to make Enhancers or Space Buildings, for example.
  • Clickables: A more generalized variant of buyables, for any kind of thing that is sometimes clickable. Between these and Buyables, you can do just about anything.
  • Achievements: How to create achievements for a layer (or for the whole game).

Other components and features ​

  • Challenges: How to create challenges for a layer.
  • Bars: Display some information as a progress bar, gauge, or similar. They are highly customizable, and can be horizontal and vertical as well.
  • Subtabs and Microtabs: Create subtabs for your tabs, as well as "microtab" components that you can put inside the tabs. You can even use them to embed a layer inside another layer!
  • [Grids][grids.md]: Create a group buttons that behave the same, but have their own data. Good for map tiles, an inventory grid, and more!
  • Infoboxes: Boxes containing text that can be shown or hidden.
  • Trees: Make your own trees. You can make non-layer button nodes too!
  • Particle system: Can be used to create particles for visual effects, but also interactable things like golden cookies or collectables.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/achievements.html b/public/kronos/docs/achievements.html index 6b5e10af..c62dc3cf 100644 --- a/public/kronos/docs/achievements.html +++ b/public/kronos/docs/achievements.html @@ -38,7 +38,7 @@ }, etc }

Usually, each achievement should have an id where the first digit is the row and the second digit is the column.

Individual achievement can have these features:

  • name: optional. displayed at the top of the achievement. The only visible text. It can also be a function that returns updating text. Can use basic HTML.

  • done(): A function returning a boolean to determine if the achievement should be awarded.

  • tooltip: Default tooltip for the achievement, appears when it is hovered over. Should convey the goal and any reward for completing the achievement. It can also be a function that returns updating text. Can use basic HTML. Setting this to "" disables the tooltip.

  • effect(): optional. A function that calculates and returns the current values of any bonuses from the achievement. Can return a value or an object containing multiple values.

  • unlocked(): optional. A function returning a bool to determine if the achievement is visible or not. Default is unlocked.

  • onComplete() - optional. this function will be called when the achievement is completed.

  • image: optional, puts the image from the given URL (relative or absolute) in the achievement

  • style: optional. Applies CSS to this achievement, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • textStyle: optional. Applies CSS to the text, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the achievement was stored under, for convenient access. The achievement in the example's id is 11.

  • goalTooltip: optional, deprecated. Appears when the achievement is hovered over and locked, overrides the basic tooltip. This is to display the goal (or a hint). It can also be a function that returns updating text. Can use basic HTML.

  • doneTooltip: optional, deprecated. Appears when the achievement is hovered over and completed, overrides the basic tooltip. This can display what the player achieved (the goal), and the rewards, if any. It can also be a function that returns updating text. Can use basic HTML.

Disable achievement popups by adding achievementsPopups: false to the layer.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/bars.html b/public/kronos/docs/bars.html index a44b5246..816536eb 100644 --- a/public/kronos/docs/bars.html +++ b/public/kronos/docs/bars.html @@ -44,7 +44,7 @@ }, etc }

Features:

  • direction: UP, DOWN, LEFT, or RIGHT (not strings). Determines the direction that the bar is filled as it progresses. RIGHT means from left to right.

  • width, height: The size in pixels of the bar, but as numbers (no "px" at the end).

  • progress(): A function that returns the portion of the bar that is filled, from "empty" at 0 to "full" at 1, updating automatically. (Nothing bad happens if the value goes out of these bounds, and it can be a number or Decimal)

  • display(): optional. A function that returns text to be displayed on top of the bar, can use HTML.

  • unlocked(): optional. A function returning a bool to determine if the bar is visible or not. Default is unlocked.

  • baseStyle, fillStyle, borderStyle, textStyle: Optional, Apply CSS to the unfilled portion, filled portion, border, and display text on the bar, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the bar was stored under, for convenient access. The bar in the example's id is "bigBar".

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/basic-layer-breakdown.html b/public/kronos/docs/basic-layer-breakdown.html index 3edbd96e..6f8d42b5 100644 --- a/public/kronos/docs/basic-layer-breakdown.html +++ b/public/kronos/docs/basic-layer-breakdown.html @@ -88,7 +88,7 @@ // Look in the upgrades docs to see what goes here! }, })

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/buyables.html b/public/kronos/docs/buyables.html index 5caa928e..b18dead1 100644 --- a/public/kronos/docs/buyables.html +++ b/public/kronos/docs/buyables.html @@ -50,7 +50,7 @@ }, etc }

Features:

  • title: optional. displayed at the top in a larger font. It can also be a function that returns updating text.

  • cost(): cost for buying the next buyable. Can have an optional argument "x" to calculate the cost of the x+1th purchase. (x is a Decimal). Can return an object if there are multiple currencies.

  • effect(): optional. A function that calculates and returns the current values of bonuses of this buyable. Can have an optional argument "x" to calculate the effect of having x of the buyable.. Can return a value or an object containing multiple values.

  • display(): A function returning everything that should be displayed on the buyable after the title, likely including the description, amount bought, cost, and current effect. Can use basic HTML.

  • unlocked(): optional. A function returning a bool to determine if the buyable is visible or not. Default is unlocked.

  • canAfford(): A function returning a bool to determine if you can buy one of the buyables.

  • buy(): A function that implements buying one of the buyable, including spending the currency.

  • buyMax(): optional. A function that implements buying as many of the buyable as possible.

  • style: optional. Applies CSS to this buyable, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • purchaseLimit: optional. The limit on how many of the buyable can be bought. The default is no limit.

  • marked: optional Adds a mark to the corner of the buyable. If it's "true" it will be a star, but it can also be an image URL.

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the buyable was stored under, for convenient access. The buyable in the example's id is 11.

Sell One/Sell All:

Including a sellOne or sellAll function will cause an additional button to appear beneath the buyable. They are functionally identical, but "sell one" appears above "sell all". You can also use them for other things.

  • sellOne/sellAll(): optional. Called when the button is pressed. The standard use would be to decrease/reset the amount of the buyable, and possibly return some currency to the player.

  • canSellOne/canSellAll(): optional. booleans determining whether or not to show the buttons. If "canSellOne/All" is absent but "sellOne/All" is present, the appropriate button will always show.

To add a respec button, or something similar, add the respecBuyables function to the main buyables object (not individual buyables). You can use these features along with it:

  • respec(): optional. This is called when the button is pressed (after a toggleable confirmation message).

  • respecText: optional. Text to display on the respec Button.

  • showRespec(): optional. A function determining whether or not to show the button, if respecBuyables is defined. Defaults to true if absent.

  • respecMessage: optional. A custom confirmation message on respec, in place of the default one.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/challenges.html b/public/kronos/docs/challenges.html index 102aed66..068ee6b5 100644 --- a/public/kronos/docs/challenges.html +++ b/public/kronos/docs/challenges.html @@ -42,7 +42,7 @@ }, etc }

Usually, each challenge should have an id where the first digit is the row and the second digit is the column.

Individual Challenges can have these features:

  • name: Name of the challenge, can be a string or a function. Can use basic HTML.

  • challengeDescription: A description of what makes the challenge a challenge. You will need to implement these elsewhere. It can also be a function that returns updating text. Can use basic HTML.

  • goalDescription: A description of the win condition for the challenge. It can also be a function that returns updating text. Can use basic HTML. (Optional if using the old goal system)

  • canComplete(): A function that returns true if you meet the win condition for the challenge. Returning a number will allow bulk completing the challenge. (Optional if using the old goal system)

  • rewardDescription: A description of the reward's effect. You will also have to implement the effect where it is applied. It can also be a function that returns updating text. Can use basic HTML.

  • rewardEffect(): optional. A function that calculates and returns the current values of any bonuses from the reward. Can return a value or an object containing multiple values. Can use basic HTML.

  • rewardDisplay(): optional. A function that returns a display of the current effects of the reward with formatting. Default behavior is to just display the a number appropriately formatted.

  • fullDisplay(): OVERRIDE. Overrides the other displays and descriptions, and lets you set the full text for the challenge. Can use basic HTML.

  • unlocked(): optional. A function returning a bool to determine if the challenge is visible or not. Default is unlocked.

  • onComplete() - optional. this function will be called when the challenge is completed when previously incomplete.

  • onEnter() - optional. this function will be called when entering the challenge

  • onExit() - optional. this function will be called when exiting the challenge in any way

  • countsAs: optional. If a challenge combines the effects of other challenges in this layer, you can use this. An array of challenge ids. The player is effectively in all of those challenges when in the current one.

  • completionLimit: optional. the amount of times you can complete this challenge. Default is 1 completion.

  • style: optional. Applies CSS to this challenge, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • marked: optional Adds a mark to the corner of the challenge. If it's "true" it will be a star, but it can also be an image URL. By default, if the challenge has multiple completions, it will be starred at max completions.

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: assigned automagically. It's the "key" which the challenge was stored under, for convenient access. The challenge in the example's id is 11.

The old goal system uses these features:

  • goal: deprecated, A Decimal for the amount of currency required to beat the challenge. By default, the goal is in basic Points. The goal can also be a function if its value changes.

  • currencyDisplayName: deprecated. the name to display for the currency for the goal

  • currencyInternalName: deprecated. the internal name for that currency

  • currencyLayer: deprecated. the internal name of the layer that currency is stored in. If it's not in a layer, omit. If it's not stored directly in a layer, instead use the next feature.

  • currencyLocation(): deprecated. if your currency is stored in something inside a layer (e.g. a buyable's amount), you can access it this way. This is a function returning the object in "player" that contains the value (like player[this.layer].buyables)

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/clickables.html b/public/kronos/docs/clickables.html index 0bcd9339..d730c5b0 100644 --- a/public/kronos/docs/clickables.html +++ b/public/kronos/docs/clickables.html @@ -38,7 +38,7 @@ } etc }

Features:

  • title: optional. displayed at the top in a larger font. It can also be a function that returns updating text.

  • effect(): optional. A function that calculates and returns the current values of bonuses of this clickable. Can return a value or an object containing multiple values.

  • display(): A function returning everything that should be displayed on the clickable after the title, likely changing based on its state. Can use basic HTML.

  • unlocked(): optional. A function returning a bool to determine if the clickable is visible or not. Default is unlocked.

  • canClick(): A function returning a bool to determine if you can click the clickable.

  • onClick(): A function that implements clicking the clickable.

  • onHold(): optional A function that is called 20x/sec when the button is held for at least 0.25 seconds.

  • style: optional. Applies CSS to this clickable, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • marked: optional Adds a mark to the corner of the clickable. If it's "true" it will be a star, but it can also be an image URL.

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the clickable was stored under, for convenient access. The clickable in the example's id is 11.

You can also use these features on the clickables object to add a button above all the clickables, for implementing a respec button or similar.

  • masterButtonPress(): optional. If present, an additional button will appear above the clickables. Pressing it will call this function.

  • masterButtonText: optional. Text to display on the Master Button.

  • showMasterButton(): optional. A function determining whether or not to show the button, if masterButtonPress is defined. Defaults to true if absent.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/custom-tab-layouts.html b/public/kronos/docs/custom-tab-layouts.html index e5ab0dc6..620f452f 100644 --- a/public/kronos/docs/custom-tab-layouts.html +++ b/public/kronos/docs/custom-tab-layouts.html @@ -52,7 +52,7 @@ "blank", "upgrades" ]

It is a list of components, which can be either just a name, or an array with arguments. If it's an array, the first item is the name of the component, the second is the data passed into it, and the third (optional) applies a CSS style to it with a "CSS object", where the keys are CSS attributes.

These are the existing components, but you can create more in components.js:

  • display-text: Displays some text (can use basic HTML). The argument is the text to display. It can also be a function that returns updating text.

  • raw-html: Displays some basic HTML, can also be a function.

  • blank: Adds empty space. The default dimensions are 8px x 17px. The argument changes the dimensions. If it's a single value (e.g. "20px"), that determines the height. If you have a pair of arguments, the first is width and the second is height.

  • row: Display a list of components horizontally. The argument is an array of components in the tab layout format.

  • column: Display a list of components vertically. The argument is an array of components in the tab layout format. This is useful to display columns within a row.

  • main-display: The text that displays the main currency for the layer and its effects. The argument is the amount of precision to use, allowing it to display non-whole numbers.

  • resource-display: The text that displays the currency that this layer is based on, as well as the best and/or total values for this layer's prestige currency (if they are put in startData for this layer).

  • prestige-button: The argument is a string that the prestige button should say before the amount of currency you will gain. It can also be a function that returns updating text.

  • text-input: A text input box. The argument is the name of the variable in player[layer] that the input is for, player[layer][argument] (Works with strings, numbers, and Decimals!)

  • slider: Lets the user input a value with a slider. The argument a 3-element array: [name, min, max]. The name is the name of the variable in player[layer] that the input that the input is for, and min and max are the limits of the slider. (Does not work for Decimal values)

  • upgrades: The layer's upgrades. The argument is optional, and is a the list of rows this component should include, if it doesn't have all of them.

  • milestones, challenges, achievements: Display the upgrades, milestones, and challenges for a layer, as appropriate.

  • buyables, clickables: Display all of the buyables/clickables for this layer, as appropriate. The argument is optional and is the size of the boxes in pixels.

  • microtabs: Display a set of subtabs for an area. The argument is the name of the set of microtabs in the "microtabs" feature.

  • bar: Display a bar. The argument is the id of the bar to display.

  • infobox: Display an infobox. The argument is the id of the infobox to display.

  • tree: Displays a tree. The argument is an array of arrays containing the names of the nodes in the tree (first by row, then by column) See here for more information on tree layouts and nodes!

  • toggle: A toggle button that toggles a bool value. The argument is a pair that identifies the location in player of the bool to toggle, e.g. [layer, id]. 'layer' also affects the color of the toggle.

  • grid: Displays the gridable grid for the layer. If you need more than one grid, use a layer proxy.

  • layer-proxy: Lets you use components from another layer. The argument is a pair, [layer, data], consisting of the id of the layer to proxy from, and the tabFormat for the components to show. (Note: you cannot use a microtab within a layer proxy)

The rest of the components are sub-components. They can be used just like other components, but are typically part of another component.

  • upgrade, milestone, challenge, buyable, clickable, achievement, gridable: An individual upgrade, challenge, etc. The argument is the id. This can be used if you want to have upgrades split up across multiple subtabs, for example.

  • respec-button, master-button: The respec and master buttons for buyables and clickables, respectively.

  • sell-one, sell-all: The "sell one" and "sell all" for buyables, respectively. The argument is the id of the buyable.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/getting-started.html b/public/kronos/docs/getting-started.html index e912e7e4..aeb4cd4a 100644 --- a/public/kronos/docs/getting-started.html +++ b/public/kronos/docs/getting-started.html @@ -26,7 +26,7 @@

Appearance

Getting started ​

Welcome to The Modding Tree!

Using the Modding Tree, at its simplest level, just requires getting a copy of it onto your computer. However, if you do it the right way, it will help in many ways.

Don't let the word "Github" scare you away. It's actually much easier to use than most people think, especially because most people use it the hard way. The key is Github Desktop, which lets you do everything you need to, without even touching the command line.

The benefits of using Github:

  • It makes it much, much easier to update The Modding Tree.
  • You can share your work without any extra effort using githack, or with a bit more effort, set up a github.io site.
  • It lets you undo changes to your code, and to have multiple versions of it.
  • It lets you collaborate with other people, if you want to.

Getting set up with Github Desktop, Visual Studio Code, and The Modding Tree: ​

  1. Install Github Desktop and Visual Studio Code.

  2. Make a Github account. You can handle this on your own.

  3. Log in on your browser, and go back to The Modding Tree page. At the top right, there should be a button that says "fork". Click on it, and then on your username. You now have your own fork, or copy, of The Modding Tree.

  4. Open Github Desktop and log in. Ignore everything else and choose "clone a repository". A "repository" is basically a "Github project", like The Modding Tree. "Cloning" is downloading a copy of the repository to your computer.

  5. Look for The Modding Tree in the list of repositiories (it should be the only one) and click "clone".

  6. Select that you're using it for your own purposes, and click continue. It will download the files and handle everything.

Using your repository ​

  1. Click on "show in explorer/finder" to the right, and then open the index.html file in the folder. The page should open up on your browser. This will let you view and test your project locally!

  2. To edit your project, click "open in VSCode" in Github Desktop.

  3. Open mod.js in VSCode, and look at the top part where it has a "modInfo" object. Fill in your mod's name to whatever you want, and change the id as well. (It can be any string value, and it's used to determine where the savefile is. Make it something that's probably unique, and don't change it again later or else it'll effectively wipe existing saves)

  4. Save mod.js, and then reload index.html in your browser. The title on the tab, as well as on the info page, will now be updated! You can reload the page every time you change the code to test it quickly and easily.

  5. Go back to Github Desktop. It's time to save your changes into the git system by making a "commit". This basically saves your work and creates a snapshot of what your code looks like at this moment, allowing you to look back at it later.

  6. At the bottom right corner, add a summary of your changes, and then click "commit to master".

  7. Finally, at the top middle, click "push origin" to push your changes out onto the online repository.

  8. You can view your project on line, or share it with others, by going to https://raw.githack.com/[YOUR-GITHUB-USERNAME]/The-Modding-Tree/master/index.html

And now, you have successfully used Github! You can look at the documentation to see how The Modding Tree's system works and to make your mod a reality.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/grids.html b/public/kronos/docs/grids.html index 8ba8fd2b..a6ad4ac3 100644 --- a/public/kronos/docs/grids.html +++ b/public/kronos/docs/grids.html @@ -66,7 +66,7 @@ etc }

Features:

  • rows, cols: The amount of rows and columns of gridable to display.

  • maxRows, maxCols: sometimes needed. If rows or cols are dynamic, you need to define the maximum amount that there can be (you can increase it when you update the game though). These CANNOT be dynamic.

  • getStartData(id): Creates the default data for the gridable at this position. This can be an object, or a regular value.

  • getUnlocked(id): optional. Returns true if the gridable at this position should be visible.

  • getTitle(data, id): optional. Returns text that should displayed at the top in a larger font, based on the position and data of the gridable.

  • getDisplay(data, id): optional. Returns everything that should be displayed on the gridable after the title, based on the position and data of the gridable.

  • getStyle(data, id): optional. Returns CSS to apply to this gridable, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • getCanClick(data, id): optional. A function returning a bool to determine if you can click a gridable, based on its data and position. If absent, you can always click it.

  • onClick(data, id): A function that implements clicking on the gridable, based on its position and data.

  • onHold(data, id): optional A function that is called 20x/sec when the button is held for at least 0.25 seconds.

  • getEffect(data, id): optional. A function that calculates and returns a gridable's effect, based on its position and data. (Whatever that means for a gridable)

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/infoboxes.html b/public/kronos/docs/infoboxes.html index d58eadd9..57c7d758 100644 --- a/public/kronos/docs/infoboxes.html +++ b/public/kronos/docs/infoboxes.html @@ -40,7 +40,7 @@ }, etc }

Features:

  • title: The text displayed above the main box. Can be a function to be dynamic, and can use basic HTML.

  • body: The text displayed inside the box. Can be a function to be dynamic, and can use basic HTML.

  • style, titleStyle, bodyStyle: optional. Apply CSS to the infobox, or to the title button or body of the infobox, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • unlocked(): optional. A function returning a bool to determine if the infobox is visible or not. Default is unlocked.

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: assigned automagically. It's the "key" which the bar was stored under, for convenient access. The infobox in the example's id is "lore".

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/layer-features.html b/public/kronos/docs/layer-features.html index 2d9069d2..f62abf55 100644 --- a/public/kronos/docs/layer-features.html +++ b/public/kronos/docs/layer-features.html @@ -46,7 +46,7 @@ "challenge"() { return {'height': '200px'} }, "prestige-button"() { return {'color': '#AA66AA'} } }
  • deactivated: optional, if this is true, hasUpgrade, hasChallenge, hasAchievement, and hasMilestone will return false for things in the layer, and you will be unable to buy or click things on the layer. You will have to disable effects of buyables, the innate layer effect, and possibly other things yourself.

Custom Prestige type ​

(All of these can also be used by other prestige types)

  • getResetGain(): mostly for custom prestige type. Returns how many points you should get if you reset now. You can call getResetGain(this.layer, useType = "static") or similar to calculate what your gain would be under another prestige type (provided you have all of the required features in the layer).

  • getNextAt(canMax=false): mostly for custom prestige type. Returns how many of the base currency you need to get to the next point. canMax is an optional variable used with Static-ish layers to differentiate between if it's looking for the first point you can reset at, or the requirement for any gain at all (Supporting both is good). You can also call getNextAt(this.layer, canMax=false, useType = "static") or similar to calculate what your next at would be under another prestige type (provided you have all of the required features in the layer).

  • canReset(): mostly for custom prestige type. Return true only if you have the resources required to do a prestige here.

  • prestigeNotify(): mostly for custom prestige types, returns true if this layer should be subtly highlighted to indicate you can prestige for a meaningful gain.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/main-mod-info.html b/public/kronos/docs/main-mod-info.html index f3887ed1..e8411c2f 100644 --- a/public/kronos/docs/main-mod-info.html +++ b/public/kronos/docs/main-mod-info.html @@ -34,7 +34,7 @@ weather: "Yes", happiness: new Decimal(72), }}

  • displayThings: An array of functions used to display extra things at the top of the tree tab. Each function returns a string, which is a line to display (with basic HTML support). If a function returns nothing, nothing is displayed (and it doesn't take up a line).

  • isEndgame(): A function to determine if the player has reached the end of the game, at which point the "you win!" screen appears.

Less important things beyond this point!

  • maxTickLength(): Returns the maximum tick length, in milliseconds. Only really useful if you have something that reduces over time, which long ticks mess up (usually a challenge).

  • fixOldSave(): Can be used to modify a save file when loading into a new version of the game. Use this to undo inflation, never forcibly hard reset your players.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/milestones.html b/public/kronos/docs/milestones.html index 0be97f8f..d49f23e1 100644 --- a/public/kronos/docs/milestones.html +++ b/public/kronos/docs/milestones.html @@ -40,7 +40,7 @@ } etc }

You can use hasMilestone(layer, id) to determine if the player has a given milestone

Milestone features:

  • requirementDescription: A string describing the requirement for unlocking this milestone. Suggestion: Use a "total". It can also be a function that returns updating text. Can use basic HTML.

  • effectDescription: A string describing the reward for having the milestone. You will have to implement the reward elsewhere. It can also be a function that returns updating text. Can use basic HTML.

  • done(): A function returning a boolean to determine if the milestone should be awarded.

  • toggles: optional. Creates toggle buttons that appear on the milestone when it is unlocked. The toggles can toggle a given boolean value in a layer. It is defined as an array of paired items, one pair per toggle. The first is the internal name of the layer the value being toggled is stored in, and the second is the internal name of the variable to toggle. (e.g. [["b", "auto"], ["g", "auto"])

    Tip: Toggles are not de-set if the milestone becomes locked! In this case, you should also check if the player has the milestone.

  • style: optional. Applies CSS to this milestone, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • unlocked(): optional. A function returning a boolean to determine if the milestone should be shown. If absent, it is always shown.

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the milestone was stored under, for convenient access. The milestone in the example's id is 0.

Disaable milestone popups by adding milestonePopups: false to the layer.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/particles.html b/public/kronos/docs/particles.html index a7225278..4cebca82 100644 --- a/public/kronos/docs/particles.html +++ b/public/kronos/docs/particles.html @@ -46,7 +46,7 @@ }, etc... }

Features can be functions or constant. These features will be called when each particle is made, with an id argument, which is assigned based on which of the amount particles being spawned this is. All of these are optional, with a default value.

All distances are in pixels and angles are in degrees, with 0 being up and going clockwise.

  • time: The amount of time, in seconds, that the particle will last. Default is 3.

  • fadeOutTime: The amount of seconds that fading out at the end should take (part of the total lifetime). Default is 1.

  • fadeInTime: The amount of seconds that fading in should take (part of the total lifetime). Default is 0.

  • image: The image the particle should display. "" will display no image. Default is a generic particle.

  • text: Displays text on the particle. Can use basic HTML.

  • style: Lets you apply other CSS styling to the particle.

  • width, height: The dimensions of the particle. Default is 35 and 35.

  • color: Sets the color of the image to this color.

  • angle: The angle that the particle should face. Default is 0.

  • dir: The initial angle that the particles should move in, before spread is factored in. Default is whatever angle is.

  • spread: If there are several particles, they will be spread out by this many degrees, centered on dir. Default is 30.

  • rotation: The amount that the (visual) angle of the particle should change by. Default is 0.

  • speed: The starting speed of the particle. Default is 15.

  • gravity: The amount the particle should accelerate downwards. Default is 0.

  • x, y: The starting coordinates of the particle. Default is at the mouse position.

  • offset: How far from the start each particle should appear. Default is 10.

  • xVel, yVel: Set initially based on other properties, then used to update movement.

  • layer: When changing tabs, if leaving the layer tab, this particle will be erased.

  • You can add other features to particles, but you must impliment their effects yourself.

Function features: These stay as functions and are for more advanced things. They are optional.

  • update(): Called each tick. Lets you do more advanced visual and movement behaviors by changing other properties.
  • onClick(), onMouseOver(), onMouseLeave(): Called when the particle is interacted with.

Other useful things that are not features of the particle object:

  • setDir(particle, dir), setSpeed(particle, speed): Set the speed/direction on a particle.
  • clearParticles(check): Function to delete particles. With no check, it deletes all particles. Check is a function that takes a particle, and returns true if that particle should be deleted.
  • You can use Vue.delete(particles, this.id) to make a particle delete itself.
  • mouseX and mouseY are variables that track the mouse position.
  • sin(x), cos(x), tan(x): functions that do these operations, with x in degrees. (Instead of radians).
  • asin(x), acos(x), atan(x): functions that do these operations, with the returned value in degrees. (instead of radians).

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/subtabs-and-microtabs.html b/public/kronos/docs/subtabs-and-microtabs.html index 7b0e8b4c..2858fe51 100644 --- a/public/kronos/docs/subtabs-and-microtabs.html +++ b/public/kronos/docs/subtabs-and-microtabs.html @@ -74,7 +74,7 @@ // There could be another set of microtabs here } }

Normal subtabs and microtab subtabs both use the same features:

Features: ​

  • content: The tab layout code for the subtab, in the tab layout format.

  • style: optional. Applies CSS to the whole subtab when switched to, in the form of an "CSS Object", where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • buttonStyle: optional. A CSS object, which affects the appearance of the button for that subtab.

  • unlocked(): optional. a function to determine if the button for this subtab should be visible. By default, a subtab is always unlocked. You can't use the "this" keyword in this function.

  • shouldNotify()/prestigeNotify(): optional, if true, the tab button will be highlighted to notify the player that there is something there.

  • glowColor: optional, specifies the color that the subtab glows. If this subtab is causing the main layer to node glow (and it would't otherwise) the node also glows this color. Is NOT overridden by embedding a layer.

  • embedLayer: SIGNIFICANT, the id of another layer. If you have this, it will override "content", "style" and "shouldNotify", instead displaying the entire layer in the subtab.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/trees-and-tree-customization.html b/public/kronos/docs/trees-and-tree-customization.html index f19f1ab7..7b65589c 100644 --- a/public/kronos/docs/trees-and-tree-customization.html +++ b/public/kronos/docs/trees-and-tree-customization.html @@ -30,7 +30,7 @@ ["a", "b", "blank", "c", "weirdButton"]]
[["p"],
  ["left", "blank", "right", "blank"]
  ["a", "b", "blank", "c", "weirdButton"]]

Nodes ​

Nodes are non-layer buttons that can go in trees. They are defined similarly to layers, but with addNode instead of addLayer.

Features:

  • color: optional, The node's color. (A string in hex format with a #)

  • symbol: optional The text on the button (The id capitalized by default)

  • canClick(): Returns true if the player can click the node. ()

  • onClick(): The function called when the node is clicked.

  • layerShown(): optional, A function returning a bool which determines if this node should be visible. It can also return "ghost", which will hide the layer, but its node will still take up space in its tree.

  • branches: optional. An array of layer/node ids. On a tree, a line will appear from this node to all of the nodes in the list. Alternatively, an entry in the array can be a 2-element array consisting of the id and a color value. The color value can either be a string with a hex color code, or a number from 1-3 (theme-affected colors).

  • nodeStyle: optional. A CSS object, where the keys are CSS attributes, which styles this node on the tree.

  • tooltip() / tooltipLocked(): optional. Functions that return text, which is the tooltip for the node when the layer is unlocked or locked, respectively. By default the tooltips behave the same as in the original Prestige Tree.

  • row: optional, the row that this node appears in (for the default tree).

  • position: optional, Determines the horizontal position of the layer in its row in a default tree. By default, it uses the id, and layers/nodes are sorted in alphabetical order.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/updating-tmt.html b/public/kronos/docs/updating-tmt.html index e2e96f51..34765f34 100644 --- a/public/kronos/docs/updating-tmt.html +++ b/public/kronos/docs/updating-tmt.html @@ -26,7 +26,7 @@

Appearance

Updating The Modding Tree ​

This tutorial assumes that you have used the Getting Started Tutorial, and are using Github Desktop and VSCode for your mod.

Here's what you have to do when there's a TMT update:

  1. Look at the changelog. It will warn you if the update will break anything or require any changes. Decide if you want to try to update.

  2. Open Github Desktop, and at the top middle, click "fetch origin". This will make Github Desktop get information about the update.

  3. Click where it says "current branch: master" at the top middle, and at the bottom of the thing that appears, click "choose a branch to merge into master".

  4. Select upstream/master. It will likely say there are conflicts, but you have tools to resolve them. Click "Merge upstream/master into master".

  5. A conflict happens when the things you're trying to merge have both made changes in the same place. Click "open in Visual Studio Code" next to the first file.

  6. Scroll down through the file, and look for the parts highlighted in red and green. One of these is your code, and the other is some code that will be modified by the update. Do your best to try to edit things to keep the updated changes, but keep your content.

  7. Continue to do this for all remaining changes.

  8. Do any other changes required by the update, run the game, fix issues, etc.

Last updated:

- + \ No newline at end of file diff --git a/public/kronos/docs/upgrades.html b/public/kronos/docs/upgrades.html index 06ee242b..f1e8d419 100644 --- a/public/kronos/docs/upgrades.html +++ b/public/kronos/docs/upgrades.html @@ -40,7 +40,7 @@ }, etc }

Usually, upgrades should have an id where the first digit is the row and the second digit is the column.

Individual upgrades can have these features:

  • title: optional. Displayed at the top in a larger font. It can also be a function that returns updating text. Can use basic HTML.

  • description: A description of the upgrade's effect. You will also have to implement the effect where it is applied. It can also be a function that returns updating text. Can use basic HTML.

  • effect(): optional. A function that calculates and returns the current values of any bonuses from the upgrade. Can return a value or an object containing multiple values.

  • effectDisplay(): optional. A function that returns a display of the current effects of the upgrade with formatting. Default displays nothing. Can use basic HTML.

  • fullDisplay(): OVERRIDE. Overrides the other displays and descriptions, and lets you set the full text for the upgrade. Can use basic HTML.

  • cost: A Decimal for the cost of the upgrade. By default, upgrades cost the main prestige currency for the layer.

  • unlocked(): optional. A function returning a bool to determine if the upgrade is visible or not. Default is unlocked.

  • onPurchase(): optional. This function will be called when the upgrade is purchased. Good for upgrades like "makes this layer act like it was unlocked first".

  • style: optional. Applies CSS to this upgrade, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the upgrade was stored under, for convenient access. The upgrade in the example's id is 11.

By default, upgrades use the main prestige currency for the layer. You can include these to change them (but it needs to be a Decimal):

  • currencyDisplayName: optional. The name to display for the currency for the upgrade.

  • currencyInternalName: optional. The internal name for that currency.

  • currencyLayer: optional. The internal name of the layer that currency is stored in. If it's not in a layer (like Points), omit. If it's not stored directly in a layer, instead use the next feature.

  • currencyLocation: optional. If your currency is stored in something inside a layer (e.g. a buyable's amount), you can access it this way. This is a function returning the object in "player" that contains the value (like player[this.layer].buyables)

If you want to do something more complicated like upgrades that cost two currencies, you can override the purchase system with these (and you need to use fullDisplay as well)

  • canAfford(): OVERRIDE, a function determining if you are able to buy the upgrade

  • pay(): OVERRIDE, a function that reduces your currencies when you buy the upgrade

Last updated:

- + \ No newline at end of file diff --git a/public/lit/Old Things/2.0-format-changes.html b/public/lit/Old Things/2.0-format-changes.html index aedb7c6d..580b3552 100644 --- a/public/lit/Old Things/2.0-format-changes.html +++ b/public/lit/Old Things/2.0-format-changes.html @@ -26,7 +26,7 @@

Appearance

2.0 format changes ​

  • Temp format is changed from temp.something[layer] to temp[layer].something, for consistency
  • Challenges are now saved as an object with the amount of completions in each spot. (This will break saves.)
  • effectDisplay in Challenges and Upgrades no longer takes an argument, and neither does effect for Buyables
  • Buyable cost can take an argument for amount of buyables, but it needs to function if no argument is supplied (it should do the cost for the next purchase).
  • Generation of Points now happens in the main game loop (not in a layer update function), enabled by canGenPoints in game.js.
  • Changed fullLayerReset to layerDataReset, which takes an array of names of values to keep

In addition, many names were changed, mostly expanding abbreviations:

All instances of:

  • chall -> challenge
  • unl -> unlocked
  • upg -> upgrade (besides CSS)
  • amt -> amount
  • desc -> description
  • resCeil -> roundUpCost
  • order -> unlockOrder
  • incr_order -> increaseUnlockOrder

Challenges:

  • desc -> challengeDescription
  • reward -> rewardDescription
  • effect -> rewardEffect
  • effectDisplay -> rewardDisplay
  • active -> challengeActive

Last updated:

- + \ No newline at end of file diff --git a/public/lit/README.html b/public/lit/README.html index 9b1babbe..c5ce9906 100644 --- a/public/lit/README.html +++ b/public/lit/README.html @@ -26,7 +26,7 @@

Appearance

Kronos ​

Play here.

Updating the website:

  • git submodule update --remote
  • git add -A
  • git commit -m "Updated kronos"
  • git push

Last updated:

- + \ No newline at end of file diff --git a/public/lit/changelog.html b/public/lit/changelog.html index 7155863b..3143cf4b 100644 --- a/public/lit/changelog.html +++ b/public/lit/changelog.html @@ -26,7 +26,7 @@

Appearance

The Modding Tree changelog: ​

v2.π: Incrementally Updated - 2/5/21 ​

  • Performance improvements.
  • Fixed tooltips overlapping with the top display.
  • Clicking a popup dismisses it immediately.
  • Added support for bulk challenge completions.
  • "Best" is updated automatically.
  • Fixed keeping Decimal values on reset.
  • Code reorganization and style improvements by fudo.

v2.3.5 - 12/21/20 ​

  • Added resetTime, which tracks the time since a layer prestiged or was reset.
  • A layer node will be highlighted red if one of its subtabs is highlighted red.
  • Fixed issues with keeping challenges, buyables, and clickables on reset.
  • Improved the unlocking of custom layers.
  • Other minor fixes.

v2.3.4 - 12/16/20 ​

  • Added a node image feature.
  • Resource display now always shows the amount of the currency the layer's gain is based on.
  • Added spacing between tree nodes.
  • Another attempt to fix tooltip flickering.

v2.3.3 - 12/13/20 ​

  • Fixed the first node in a row always taking up space.
  • layerShown is now optional.
  • All prestige types can now use features for custom prestige types.

v2.3.2 - 12/13/20 ​

  • Fixed achievement/milestone popups.

v2.3.1 - 12/12/20 ​

  • Another attempt to fix flickering tooltips.
  • The "this" keyword should work everywhere except tabFormat arrays (although I may have missed some things).
  • Fixed tree branches not updating when scrolling on the right-side tab.
  • Fixed a spacing issue when a node's symbol is ""
  • Removed some old, unneeded files.

v2.3: Cooler and Newer Edition - 12/10/20 ​

  • Added achievement/milestone popups (thank you to Jacorb for this contribution!)
  • The changelog tab is back, and can be set in mod.js.
  • Layer nodes and respec buttons will not be clicked by pressing "enter".
  • Possible fix for flickering tooltips and strange transitions.
  • The victory screen text is configurable.
  • Added image and textStyle features to achievements.
  • Added an argument to use specific rows in an "upgrades" component.
  • Fixed the comma appearing in the main display when there was no effectDescription
  • Added the ability to easily make a tab that is a collection of layers in subtabs.
  • Improved spacing for embedding layers with subtabs into subtabs.

v2.2.8 - 12/03/20 ​

  • Double-clicking a layer node brings you to the main subtab for that layer.
  • Attempted to fix challenges visually updating a different way.
  • Added a softcap function for use in formulas.
  • Added displayRow feature, which lets layers be shown somewhere separate from where they are in the reset order (e.g. side layers)
  • Fixed autoupgrade issue.

v2.2.7 - 11/30/20 ​

  • Added autoUpgrade feature.
  • resource-display now shows resource gain per second if passiveGain is active.
  • Fixed formatting issues on some large numbers.
  • Better support for using classed objects in player and in layers/tmp.
  • Made hard resetting more effective.
  • Removed Herobrine from getStartClickables.

v2.2.6 - 11/30/20 ​

  • Added goalDescription for challenges and made the new "canComplete" system the standard.
  • Another attempt to fix challenges not visually updating.
  • Fixed side layers not appearing.
  • Fixed getStartClickables again.

v2.2.5 - 11/29/20 ​

  • Added features for overriding the displays and costs/goals of upgrades and challenges to make them fully custom.
  • best, total, and unlocked are always automatically added to layerData (but best and total will only display if you add them yourself).
  • Fixed getStartClickables.

v2.2.4 - 11/28/20 ​

  • Added softcap and softcapPower features (for Normal layers)
  • Offline time limit and default max tick length were fixed (previously the limits were 1000x too large)
  • Added fixOldSaves.
  • You can use HTML in main-display.
  • Fixed a number of minor oddities.

v2.2.3 - 11/28/20 ​

  • Layers will be highlighted if you can finish a challenge.
  • The "can complete challenge" color now overrides the "already completed" color.
  • Button nodes now work as side "layers".
  • Setting a tooltip to "" hides it entirely.

v2.2.2 - 11/22/20 ​

  • Fixed right half of the screen being unclickable in some circumstances.
  • Fixed tree branches being offset.
  • Fix to lastSafeTab.

v2.2.1 - 11/7/20 ​

  • Added a small highlight to layers you can meaningfully prestige on.
  • Added passiveGeneration and autoPrestige features to standardize prestige automation. (The old ways still work, but the new ones work better with other things)
  • Improved milestones visually a bit.
  • "best" and "total" are now only displayed if present in startData.
  • Fixed issues with things not updating visually. (Thank you to to Jacorb!)
  • Side layers and button nodes can now be highlighted.
  • Updated docs on the new tree-related features.

v2.2: Uprooted - 11/7/20 ​

  • You can now embed a layer inside of a subtab or microtab!
  • Added support for hiding or reformatting the tree tab
  • Added non-layer button nodes
  • Added shouldNotify to subtab/microtab buttons. (You can make them highlighted)
  • Added commas to large exponents.
  • Upgrades now only show "currently" if they have an effectDisplay (so not for constant effects).
  • Achievements are part of the default tab format.
  • NaN is now handled more intelligently.
  • Renamed files, and moved less relevant ones to another folder.
  • The "hide completed challenges" setting now only hides challenges at max completions.
  • Thank you to thepaperpilot for fixing errors in docs and improving the infobox appearance!
  • Many other minor fixes.

v2.1.4 - 10/25/20 ​

  • Added an infobox component. Thank you to thepaperpilot for this contribution!
  • Layer type is now optional, and defaults to "none".
  • Improved the look of bars and tab buttons.
  • Improved spacing between layer nodes (also thanks to thepaperpilot!)
  • Fixed the "blank" component breaking if only specifying the height.
  • Fixed some numbers not displaying with enough digits.
  • Made a few more things able to be functions.
  • A few other minor fixes.

v2.1.3.1 - 10/21/20 ​

  • Fixed the update function.

v2.1.3 - 10/21/20 ​

  • gainMult and gainExp are now optional.
  • Layer unlocking is now kept on reset.
  • Game should start up faster.
  • Layer updates now have a determined order and starts with earlier-rowed layers.
  • Automation now has a determined order and starts with later-rowed layers.
  • Fixed issues with resetting clickables and challenges.
  • Commas should no longer appear in the decimal places of a number.
  • Fixed potential issue in displaying the tree.

v2.1.2 - 10/19/20 ​

  • Added buyUpgrade function (buyUpg still works though)
  • Added author name to modInfo.
  • Fix to crash caused when the name of a subtab or microtab is changed.
  • Fixes to outdated information in docs.
  • Improvements to Discord links.
  • Thank you to thepaperpilot for contributing to this update!

v2.1.1 - 10/17/20 ​

  • Added resource-display component, which displays the base currency for the prestige layer, as well as the best and/or total of this layer's prestige currency.
  • Fixed the value for the base currency not updating in resource-display.

v2.1: We should have thought of this sooner! - 10/17/20 ​

  • Moved most of the code users will want to edit to mod.js, added documentation for it.
    • Specifically, modInfo, VERSION, canGenPoints, getPointGen, and maxTickLength
  • Added getStartPoints()
  • Added the ability to store non-layer-related data
  • Added the ability to display more things at the top of the tree tab below points.
  • Made the endgame condition customizable
  • Added "sell one" and "sell all" buttons for buyables.
  • Moved the old "game" to demo.js, and replaced it with a minimal game that won't cause issues when edited.
  • Fixed issues with version number
  • Fixed number formatting issue making things like "10e9" appear.

v2.0.5 - 10/16/20 ​

  • Made more features (including prestige parameters) able to be dynamic.
  • Layer nodes can be hidden but still take up space with "ghost" visibility
  • Added clickableEffect for real.
  • Fixed some visual issues with bars.
  • A few other minor tweaks and improvements.

v2.0.4 - 10/16/20 ​

  • Fixed HTML on buttons interfering with clicking on them.

v2.0.3 - 10/16/20 ​

  • Fixed hotkeys not displaying in info.
  • Fixed the game supressing all external hotkeys.
  • You can use more things as currencies for upgrade costs and challenge goals using currencyLocation.
  • Added maxTickLength, which can be used to prevent offline time or tab-switching from breaking time-limit based mechanics.
  • Made buyable respec buttons and clickable "master" buttons their own components, and gave them a hide/show feature.
  • Added a general "tooltip" feature for achievements.

v2.0.2 - 10/15/20 ​

  • Branches are now dynamic (they can be functions).
  • Fixed a crash related to offline time.
  • Fixed links being too wide.

v2.0.1 - 10/15/20 ​

  • Fixed side layers appearing multiple times.

v2.0: The Pinnacle of Achievement Mountain - 10/15/20 ​

  • Added progress bars, which are highly customizable and can be horizontal or vertical!
  • Added "side layers", displayed smaller and off to the side, and don't get reset by default. They can be used for global achievements and statistics. Speaking of which...
  • Added achievements!
  • Added clickables, a more generalized variant of buyables.
  • Almost every value in layer data can be either a function or a constant value!
  • Added support for multiple completions of challenges.
  • Added "none" prestige type, which removes the need for any other prestige-related features.
  • The points display and other gui elements stay at the top of the screen when the tree scrolls.
  • Added getter/setter functions for the amounts and effects of most Big Features
  • Moved modInfo to game.js, added a spot in modInfo for a Discord link, changelog link. Also added a separate mod version from the TMT version in VERSION.
  • Tree structure is based on layer data, no index.html editing is needed.
  • Tmp does not need to be manually updated.
  • You don't have to have the same amount of upgrades in every row (and challs and buyables)
  • "unlocked" is optional for all Big Components (defaults to true).
  • All displays will update correctly.
  • Changelog is no longer in index.html at all.
  • Generation of Points now happens in the main game loop
  • Changed the reset functions to make keeping things easier
  • Renamed many things to increase readability (see the list in the link below)
  • Improved documentation based on feedback

v1.3.5: ​

  • Completely automated convertToDecimal, now you never have to worry about it again.
  • Branches can be defined without a color id. But they can also use hex values for color ids!
  • Created a tutorial for getting started with TMT and Github.
  • Page title is now automatically taken from mod name.

v1.3.4 - 10/8/20 ​

  • Added "midsection" feature to add things to a tab's layout while still keeping the standard layout.
  • Fix for being able to buy more buyables than you should.

v1.3.3 - 10/7/20 ​

  • Fix for the "order of operations" issue in temp.

v1.3.1 - 10/7/20 ​

  • Added custom CSS and tooltips for Layer Nodes.
  • Added custom CSS for upgrades, buyables, milestones, and challenges, both individually and layer-wide.
  • You can now use HTML in most display text!
  • You can now make milestones unlockable and not display immediately.
  • Fixed importing saves, and issue with upgrades not appearing, and probably more.
  • Optional "name" layer feature, used in confirmation messages.

v1.3: Tabception... ception! - 10/7/20 ​

  • Added subtabs! And also a Micro-tab component to let you make smaller subtab-esque areas anywhere.
  • Added a "custom" prestige formula type, and a number of features to support it.
  • Added points/sec display (can be disabled).
  • Added h-line, v-line and image-display components, plus components for individual upgrades, challenges, and milestones.
  • Added upgEffect, buyableEffect, and challEffect functions.
  • Added "hide completed challenges" setting.
  • Moved old changelogs to a separate place.
  • Fixed hasMilestone and incr_order.
  • Static layers now show the currency amount needed for the next one if you can buy max.

v1.2.4 - 10/4/20 ​

  • Layers are now highlighted if you can buy an upgrade, and a new feature, shouldNotify, lets you make it highlight other ways.
  • Fixed bugs with hasUpg, hasChall, hasMilestone, and inChallenge.
  • Changed the sample code to use the above functions for convenience.

v1.2.3 - 10/3/20 ​

  • Added a row component, which displays a list of objects in a row.
  • Added a column component, which displays a list of objects in a column (useful within a row).
  • Changed blanks to have a customizable width and height.

v1.2: This Changes Everything! - 10/3/20 ​

  • Many layer features can now be static values or functions. (This made some formats change, which will break old things)
  • You can now use the "this" keyword, to make code easier to transfer when making new layers.
  • Also added "this.layer", which is the current layer's name, and works on existing subfeatures (e.g. individual upgrades) as well! Subfeatures also have "this.id".
  • Fixed a big save issue. If you use a unique mod id, your save will never conflict with other mods.
  • Added a configurable offline time limit in modinfo at the top of index.html. (default 1 hour)
  • Added a few minor features, and updated the docs with new information.

v1.1.1: ​

  • You can define hotkeys directly from layer config.

v1.1: Enhanced Edition ​

  • Added "Buyables", which can function like Space Buildings or Enhancers.
  • Custom CSS can now be used on any component! Make the third argument an object with CSS parameters.
  • Lots of minor good things.

v1.0: ​

  • First release.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/!general-info.html b/public/lit/docs/!general-info.html index b993fa72..f94a2a6a 100644 --- a/public/lit/docs/!general-info.html +++ b/public/lit/docs/!general-info.html @@ -26,7 +26,7 @@

Appearance

The-Modding-Tree ​

The main way to add content is through creating layers. You can either add a layer directly in the layers object in layerSupport.js, or declare it in another file and register it by calling addLayer(layername, layerdata). There is an example layer registration in layers.js showing the recommended method. It is just an example and can be freely deleted. You can also use it as a reference or a base for your own layers.

The first thing you need to do is fill out the modInfo object at the top of mod.js to set your mod's name, ID (a string), and other information. A unique modId will prevent your mod's saves from conflicting with other mods. Note that changing this after people have started playing will reset their saves.

Most of the time, you won't need to dive deep into the code to create things, but you still can if you really want to, for example to add new Vue components in v.js.

The Modding Tree uses break_eternity.js to store large values. This means that many numbers are Decimal objects, and must be treated differently. For example, you have to use new Decimal(x) to create a Decimal value instead of a plain number, and perform operations on them by calling functions. e.g, instead of x = x + y, use x = x.add(y). Keep in mind this also applies to comparison operators, which should be replaced with calling the .gt, .gte, .lt, .lte, .eq, and .neq functions. See the break_eternity.js docs for more details on working with Decimal values.

Almost all values can be either a constant value, or a dynamic value. Dynamic values are defined by putting a function that returns what the value should be at any given time.

All display text can use basic HTML elements (But you can't use most Vue features there).

While reading this documentation, the following key will be used when describing features:

  • No label: This is required and the game may crash if it isn't included.
  • sometimes required: This is may be required, depending on other things in the layer.
  • optional: You can leave this out if you don't intend to use that feature for the layer.
  • assigned automagically: This value will be set automatically and override any value you set.
  • deprecated: This feature is not recommended to be used anymore, and may be removed in future versions of TMT.

Table of Contents ​

General ​

  • Getting Started: Getting your own copy of the code set up with Github Desktop.
  • Main mod info: How to set up general things for your mod in mod.js.
  • Basic layer breakdown: Breaking down the components of a layer with minimal features.
  • Layer features: Explanations of all of the different properties that you can give a layer.
  • Custom Tab Layouts: An optional way to give your tabs a different layout. You can even create entirely new components to use.
  • Custom game layouts: You can get rid of the tree tab, add buttons and other things to the tree, or even customize the tab's layout like a layer tab.
  • Updating TMT: Using Github Desktop to update your mod's version of TMT.

Common components ​

  • Upgrades: How to create upgrades for a layer.
  • Milestones: How to create milestones for a layer.
  • Buyables: Create rebuyable upgrades for your layer (with the option to make them respec-able). Can be used to make Enhancers or Space Buildings.
  • Clickables: A more generalized variant of buyables, for any kind of thing that is sometimes clickable. Between these and Buyables, you can do just about anything.

Other components and features ​

  • Challenges: How to create challenges for a layer.
  • Bars: Display some information as a progress bar, gauge, or similar. They are highly customizable, and can be horizontal and vertical as well.
  • Subtabs and Microtabs: Create subtabs for your tabs, as well as "microtab" components that you can put inside the tabs. You can even use them to embed a layer inside another layer!
  • Achievements: How to create achievements for a layer (or for the whole game).
  • Infoboxes: Boxes containing text that can be shown or hidden.
  • Trees: Make your own trees. You can make non-layer button nodes too!

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/achievements.html b/public/lit/docs/achievements.html index af6bd2ae..f2ee0e86 100644 --- a/public/lit/docs/achievements.html +++ b/public/lit/docs/achievements.html @@ -42,7 +42,7 @@ }, etc }

Each achievement should have an id where the first digit is the row and the second digit is the column.

Individual achievement can have these features:

  • name: optional. displayed at the top of the achievement. The only visible text. It can also be a function that returns updating text. Can use basic HTML.

  • done(): A function returning a boolean to determine if the achievement should be awarded.

  • tooltip: Default tooltip for the achievement, appears when it is hovered over. Should convey the goal and any reward for completing the achievement. It can also be a function that returns updating text. Can use basic HTML. Setting this to "" disables the tooltip.

  • effect(): optional. A function that calculates and returns the current values of any bonuses from the achievement. Can return a value or an object containing multiple values.

  • unlocked(): optional. A function returning a bool to determine if the achievement is visible or not. Default is unlocked.

  • onComplete() - optional. this function will be called when the achievement is completed.

  • image: optional, puts the image from the given URL (relative or absolute) in the achievement

  • style: optional. Applies CSS to this achievement, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • textStyle: optional. Applies CSS to the text, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the achievement was stored under, for convenient access. The achievement in the example's id is 11.

  • goalTooltip: optional, deprecated. Appears when the achievement is hovered over and locked, overrides the basic tooltip. This is to display the goal (or a hint). It can also be a function that returns updating text. Can use basic HTML.

  • doneTooltip: optional, deprecated. Appears when the achievement is hovered over and completed, overrides the basic tooltip. This can display what the player achieved (the goal), and the rewards, if any. It can also be a function that returns updating text. Can use basic HTML.

Disable achievement popups by adding achievementsPopups: false to the layer.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/bars.html b/public/lit/docs/bars.html index a2f5e3ee..07cf7277 100644 --- a/public/lit/docs/bars.html +++ b/public/lit/docs/bars.html @@ -44,7 +44,7 @@ }, etc }

Features:

  • direction: UP, DOWN, LEFT, or RIGHT (not strings). Determines the direction that the bar is filled as it progresses. RIGHT means from left to right.

  • width, height: The size in pixels of the bar, but as numbers (no "px" at the end).

  • progress(): A function that returns the portion of the bar that is filled, from "empty" at 0 to "full" at 1, updating automatically. (Nothing bad happens if the value goes out of these bounds, and it can be a number or Decimal)

  • display(): optional. A function that returns text to be displayed on top of the bar, can use HTML.

  • unlocked(): optional. A function returning a bool to determine if the bar is visible or not. Default is unlocked.

  • baseStyle, fillStyle, borderStyle, textStyle: Optional, Apply CSS to the unfilled portion, filled portion, border, and display text on the bar, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the bar was stored under, for convenient access. The bar in the example's id is "bigBar".

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/basic-layer-breakdown.html b/public/lit/docs/basic-layer-breakdown.html index 908e2085..06711830 100644 --- a/public/lit/docs/basic-layer-breakdown.html +++ b/public/lit/docs/basic-layer-breakdown.html @@ -80,7 +80,7 @@ layerShown() { return true } // Returns a bool for if this layer's node should be visible in the tree. })

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/buyables.html b/public/lit/docs/buyables.html index 3b58ef57..58bb0239 100644 --- a/public/lit/docs/buyables.html +++ b/public/lit/docs/buyables.html @@ -54,7 +54,7 @@ }, etc }

Features:

  • title: optional. displayed at the top in a larger font. It can also be a function that returns updating text.

  • cost(): cost for buying the next buyable. Can have an optional argument "x" to calculate the cost of the x+1th object, but needs to use "current amount" as a default value for x. (x is a Decimal). Can return an object if there are multiple currencies.

  • effect(): optional. A function that calculates and returns the current values of bonuses of this buyable. Can return a value or an object containing multiple values.

  • display(): A function returning everything that should be displayed on the buyable after the title, likely including the description, amount bought, cost, and current effect. Can use basic HTML.

  • unlocked(): optional. A function returning a bool to determine if the buyable is visible or not. Default is unlocked.

  • canAfford(): A function returning a bool to determine if you can buy one of the buyables.

  • buy(): A function that implements buying one of the buyable, including spending the currency.

  • buyMax(): optional. A function that implements buying as many of the buyable as possible.

  • style: optional. Applies CSS to this buyable, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the buyable was stored under, for convenient access. The buyable in the example's id is 11.

Sell One/Sell All:

Including a sellOne or sellAll function will cause an additional button to appear beneath the buyable. They are functionally identical, but "sell one" appears above "sell all". You can also use them for other things.

  • sellOne/sellAll(): optional. Called when the button is pressed. The standard use would be to decrease/reset the amount of the buyable, and possibly return some currency to the player.

  • canSellOne/canSellAll(): optional. booleans determining whether or not to show the buttons. If "canSellOne/All" is absent but "sellOne/All" is present, the appropriate button will always show.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/challenges.html b/public/lit/docs/challenges.html index 16163a4c..4fa20ca5 100644 --- a/public/lit/docs/challenges.html +++ b/public/lit/docs/challenges.html @@ -46,7 +46,7 @@ }, etc }

Each challenge should have an id where the first digit is the row and the second digit is the column.

Individual Challenges can have these features:

  • name: Name of the challenge, can be a string or a function. Can use basic HTML.

  • challengeDescription: A description of what makes the challenge a challenge. You will need to implement these elsewhere. It can also be a function that returns updating text. Can use basic HTML.

  • goalDescription: A description of the win condition for the challenge. It can also be a function that returns updating text. Can use basic HTML. (Optional if using the old goal system)

  • canComplete(): A function that returns true if you meet the win condition for the challenge. Returning a number will allow bulk completing the challenge. (Optional if using the old goal system)

  • rewardDescription: A description of the reward's effect. You will also have to implement the effect where it is applied. It can also be a function that returns updating text. Can use basic HTML.

  • rewardEffect(): optional. A function that calculates and returns the current values of any bonuses from the reward. Can return a value or an object containing multiple values. Can use basic HTML.

  • rewardDisplay(): optional. A function that returns a display of the current effects of the reward with formatting. Default behavior is to just display the a number appropriately formatted.

  • fullDisplay(): OVERRIDE. Overrides the other displays and descriptions, and lets you set the full text for the challenge. Can use basic HTML.

  • unlocked(): optional. A function returning a bool to determine if the challenge is visible or not. Default is unlocked.

  • onComplete() - optional. this function will be called when the challenge is completed when previously incomplete.

  • countsAs: optional. If a challenge combines the effects of other challenges in this layer, you can use this. An array of challenge ids. The player is effectively in all of those challenges when in the current one.

  • completionLimit: optional. the amount of times you can complete this challenge. Default is 1 completion.

  • style: optional. Applies CSS to this challenge, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: assigned automagically. It's the "key" which the challenge was stored under, for convenient access. The challenge in the example's id is 11.

The old goal system uses these features:

  • goal: deprecated, A Decimal for the amount of currency required to beat the challenge. By default, the goal is in basic Points. The goal can also be a function if its value changes.

  • currencyDisplayName: deprecated. the name to display for the currency for the goal

  • currencyInternalName: deprecated. the internal name for that currency

  • currencyLayer: deprecated. the internal name of the layer that currency is stored in. If it's not in a layer, omit. If it's not stored directly in a layer, instead use the next feature.

  • currencyLocation(): deprecated. if your currency is stored in something inside a layer (e.g. a buyable's amount), you can access it this way. This is a function returning the object in "player" that contains the value (like player[this.layer].buyables)

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/clickables.html b/public/lit/docs/clickables.html index 1e25058b..9c65e797 100644 --- a/public/lit/docs/clickables.html +++ b/public/lit/docs/clickables.html @@ -42,7 +42,7 @@ } etc }

Features:

  • title: optional. displayed at the top in a larger font. It can also be a function that returns updating text.

  • effect(): optional. A function that calculates and returns the current values of bonuses of this clickable. Can return a value or an object containing multiple values.

  • display(): A function returning everything that should be displayed on the clickable after the title, likely changing based on its state. Can use basic HTML.

  • unlocked(): optional. A function returning a bool to determine if the clickable is visible or not. Default is unlocked.

  • canClick(): A function returning a bool to determine if you can click the clickable.

  • onClick(): A function that implements clicking one of the clickable.

  • style: optional. Applies CSS to this clickable, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the clickable was stored under, for convenient access. The clickable in the example's id is 11.

You can also use these features on the clickables object to add a button above all the clickables, for implementing a respec button or similar.

  • masterButtonPress(): optional. If present, an additional button will appear above the clickables. Pressing it will call this function.

  • masterButtonText: optional. Text to display on the Master Button.

  • showMasterButton(): optional. A function determining whether or not to show the button. Defaults to true if absent.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/custom-tab-layouts.html b/public/lit/docs/custom-tab-layouts.html index efce831e..377bbba8 100644 --- a/public/lit/docs/custom-tab-layouts.html +++ b/public/lit/docs/custom-tab-layouts.html @@ -52,7 +52,7 @@ "blank", "upgrades" ]

It is a list of components, which can be either just a name, or an array with arguments. If it's an array, the first item is the name of the component, the second is the data passed into it, and the third (optional) applies a CSS style to it with a "CSS object", where the keys are CSS attributes.

These are the existing components, but you can create more in components.js:

  • display-text: Displays some text (can use basic HTML). The argument is the text to display. It can also be a function that returns updating text.

  • raw-html: Displays some basic HTML, can also be a function.

  • blank: Adds empty space. The default dimensions are 8px x 17px. The argument changes the dimensions. If it's a single value (e.g. "20px"), that determines the height. If you have a pair of arguments, the first is width and the second is height.

  • row: Display a list of components horizontally. The argument is an array of components in the tab layout format.

  • column: Display a list of components vertically. The argument is an array of components in the tab layout format. This is useful to display columns within a row.

  • main-display: The text that displays the main currency for the layer and its effects.

  • resource-display: The text that displays the currency that this layer is based on, as well as the best and/or total values for this layer's prestige currency (if they are put in startData for this layer).

  • prestige-button: The argument is a string that the prestige button should say before the amount of currency you will gain. It can also be a function that returns updating text.

  • upgrades: The layer's upgrades. The argument is optional, and is a the list of rows this component should include, if it doesn't have all of them.

  • milestones, challenges, achievements: Display the upgrades, milestones, and challenges for a layer, as appropriate.

  • buyables, clickables: Display all of the buyables/clickables for this layer, as appropriate. The argument is optional and is the size of the boxes in pixels.

  • microtabs: Display a set of subtabs for an area. The argument is the name of the set of microtabs in the "microtabs" feature.

  • bar: Display a bar. The argument is the id of the bar to display.

  • infobox: Display an infobox. The argument is the id of the infobox to display.

  • tree: Displays a tree. The argument is an array of arrays containing the names of the nodes in the tree (first by row, then by column) See here for more information on tree layouts and nodes!

  • toggle: A toggle button that toggles a bool value. The data is a pair that identifies what bool to toggle, e.g. [layer, id]

The rest of the components are sub-components. They can be used just like other components, but are typically part of another component.

  • upgrade, milestone, challenge, buyable, clickable, achievement: An individual upgrade, challenge, etc. The argument is the id. This can be used if you want to have upgrades split up across multiple subtabs, for example.

  • respec-button, master-button: The respec and master buttons for buyables and clickables, respectively.

  • sell-one, sell-all: The "sell one" and "sell all" for buyables, respectively. The argument is the id of the buyable.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/getting-started.html b/public/lit/docs/getting-started.html index 855c62b6..70f7f86b 100644 --- a/public/lit/docs/getting-started.html +++ b/public/lit/docs/getting-started.html @@ -26,7 +26,7 @@

Appearance

Getting started ​

Welcome to The Modding Tree!

Using the Modding Tree, at its simplest level, just requires getting a copy of it onto your computer. However, if you do it the right way, it will help in many ways.

Don't let the word "Github" scare you away. It's actually much easier to use than most people think, especially because most people use it the hard way. The key is Github Desktop, which lets you do everything you need to, without even touching the command line.

The benefits of using Github:

  • It makes it much, much easier to update The Modding Tree.
  • You can share your work without any extra effort using githack, or with a bit more effort, set up a github.io site.
  • It lets you undo changes to your code, and to have multiple versions of it.
  • It lets you collaborate with other people, if you want to.

Getting set up with Github Desktop, Visual Studio Code, and The Modding Tree: ​

  1. Install Github Desktop and Visual Studio Code.

  2. Make a Github account. You can handle this on your own.

  3. Log in on your browser, and go back to The Modding Tree page. At the top right, there should be a button that says "fork". Click on it, and then on your username. You now have your own fork, or copy, of The Modding Tree.

  4. Open Github Desktop and log in. Ignore everything else and choose "clone a repository". A "repository" is basically a "Github project", like The Modding Tree. "Cloning" is downloading a copy of the repository to your computer.

  5. Look for The Modding Tree in the list of repositiories (it should be the only one) and click "clone".

  6. Select that you're using it for your own purposes, and click continue. It will download the files and handle everything.

Using your repository ​

  1. Click on "show in explorer/finder" to the right, and then open the index.html file in the folder. The page should open up on your browser. This will let you view and test your project locally!

  2. To edit your project, click "open in VSCode" in Github Desktop.

  3. Open mod.js in VSCode, and look at the top part where it has a "modInfo" object. Fill in your mod's name to whatever you want, and change the id as well. (It can be any string value, and it's used to determine where the savefile is. Make it something that's probably unique, and don't change it again later or else it'll effectively wipe existing saves)

  4. Save mod.js, and then reload index.html in your browser. The title on the tab, as well as on the info page, will now be updated! You can reload the page every time you change the code to test it quickly and easily.

  5. Go back to Github Desktop. It's time to save your changes into the git system by making a "commit". This basically saves your work and creates a snapshot of what your code looks like at this moment, allowing you to look back at it later.

  6. At the bottom right corner, add a summary of your changes, and then click "commit to master".

  7. Finally, at the top middle, click "push origin" to push your changes out onto the online repository.

  8. You can view your project on line, or share it with others, by going to https://raw.githack.com/[YOUR-GITHUB-USERNAME]/The-Modding-Tree/master/index.html

And now, you have successfully used Github! You can look at the documentation to see how The Modding Tree's system works and to make your mod a reality.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/infoboxes.html b/public/lit/docs/infoboxes.html index def727e3..f79b371b 100644 --- a/public/lit/docs/infoboxes.html +++ b/public/lit/docs/infoboxes.html @@ -40,7 +40,7 @@ }, etc }

Features:

  • title: The text displayed above the main box. Can be a function to be dynamic, and can use basic HTML.

  • body: The text displayed inside the box. Can be a function to be dynamic, and can use basic HTML.

  • style, titleStyle, bodyStyle: optional. Apply CSS to the infobox, or to the title button or body of the infobox, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • unlocked(): optional. A function returning a bool to determine if the infobox is visible or not. Default is unlocked.

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar

  • id: assigned automagically. It's the "key" which the bar was stored under, for convenient access. The infobox in the example's id is "lore".

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/layer-features.html b/public/lit/docs/layer-features.html index 8e27708f..d83c7e38 100644 --- a/public/lit/docs/layer-features.html +++ b/public/lit/docs/layer-features.html @@ -44,7 +44,7 @@ "challenge"() { return {'height': '200px'} }, "prestige-button"() { return {'color': '#AA66AA'} } }

Custom Prestige type ​

(All of these can also be used by other prestige types)

  • getResetGain(): mostly for custom prestige type. Returns how many points you should get if you reset now. You can call getResetGain(this.layer, useType = "static") or similar to calculate what your gain would be under another prestige type (provided you have all of the required features in the layer).

  • getNextAt(canMax=false): mostly for custom prestige type. Returns how many of the base currency you need to get to the next point. canMax is an optional variable used with Static-ish layers to differentiate between if it's looking for the first point you can reset at, or the requirement for any gain at all (Supporting both is good). You can also call getNextAt(this.layer, canMax=false, useType = "static") or similar to calculate what your next at would be under another prestige type (provided you have all of the required features in the layer).

  • canReset(): mostly for custom prestige type. Return true only if you have the resources required to do a prestige here.

  • prestigeNotify(): mostly for custom prestige types, returns true if this layer should be subtly highlighted to indicate you can prestige for a meaningful gain.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/main-mod-info.html b/public/lit/docs/main-mod-info.html index f483a153..51f69d84 100644 --- a/public/lit/docs/main-mod-info.html +++ b/public/lit/docs/main-mod-info.html @@ -34,7 +34,7 @@ weather: "Yes", happiness: new Decimal(72), }}

  • displayThings: An array of functions used to display extra things at the top of the tree tab. Each function returns a string, which is a line to display (with basic HTML support). If a function returns nothing, nothing is displayed (and it doesn't take up a line).

  • isEndgame(): A function to determine if the player has reached the end of the game, at which point the "you win!" screen appears.

Less important things beyond this point!

  • maxTickLength(): Returns the maximum tick length, in milliseconds. Only really useful if you have something that reduces over time, which long ticks mess up (usually a challenge).

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/milestones.html b/public/lit/docs/milestones.html index ba050e3b..cfc12be7 100644 --- a/public/lit/docs/milestones.html +++ b/public/lit/docs/milestones.html @@ -40,7 +40,7 @@ } etc }

You can use hasMilestone(layer, id) to determine if the player has a given milestone

Milestone features:

  • requirementDescription: A string describing the requirement for unlocking this milestone. Suggestion: Use a "total". It can also be a function that returns updating text. Can use basic HTML.

  • effectDescription: A string describing the reward for having the milestone. You will have to implement the reward elsewhere. It can also be a function that returns updating text. Can use basic HTML.

  • done(): A function returning a boolean to determine if the milestone should be awarded.

  • toggles: optional. Creates toggle buttons that appear on the milestone when it is unlocked. The toggles can toggle a given boolean value in a layer. It is defined as an array of paired items, one pair per toggle. The first is the internal name of the layer the value being toggled is stored in, and the second is the internal name of the variable to toggle. (e.g. [["b", "auto"], ["g", "auto"])

    Tip: Toggles are not de-set if the milestone becomes locked! In this case, you should also check if the player has the milestone.

  • style: optional. Applies CSS to this milestone, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • unlocked(): optional. A function returning a boolean to determine if the milestone should be shown. If absent, it is always shown.

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the milestone was stored under, for convenient access. The milestone in the example's id is 0.

Disaable milestone popups by adding milestonePopups: false to the layer.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/subtabs-and-microtabs.html b/public/lit/docs/subtabs-and-microtabs.html index c4b76153..99230db4 100644 --- a/public/lit/docs/subtabs-and-microtabs.html +++ b/public/lit/docs/subtabs-and-microtabs.html @@ -74,7 +74,7 @@ // There could be another set of microtabs here } }

Normal subtabs and microtab subtabs both use the same features:

Features: ​

  • content: The tab layout code for the subtab, in the tab layout format.

  • style: optional. Applies CSS to the whole subtab when switched to, in the form of an "CSS Object", where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • buttonStyle: optional. A CSS object, which affects the appearance of the button for that subtab.

  • unlocked(): optional. a function to determine if the button for this subtab should be visible. By default, a subtab is always unlocked. You can't use the "this" keyword in this function.

  • shouldNotify(): optional, if true, the tab button will be highlighted to notify the player that there is something there.

  • embedLayer: SIGNIFICANT, the id of another layer. If you have this, it will override "content", "style" and "shouldNotify", instead displaying the entire layer in the subtab.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/trees-and-tree-customization.html b/public/lit/docs/trees-and-tree-customization.html index 03c89a98..594d732a 100644 --- a/public/lit/docs/trees-and-tree-customization.html +++ b/public/lit/docs/trees-and-tree-customization.html @@ -30,7 +30,7 @@ ["a", "b", "blank", "c", "weirdButton"]]
[["p"],
  ["left", "blank", "right", "blank"]
  ["a", "b", "blank", "c", "weirdButton"]]

Nodes ​

Nodes are non-layer buttons that can go in trees. They are defined similarly to layers, but with addNode instead of addLayer.

Features:

  • color: optional, The node's color. (A string in hex format with a #)

  • symbol: optional The text on the button (The id capitalized by default)

  • canClick(): Returns true if the player can click the node. ()

  • onClick(): The function called when the node is clicked.

  • layerShown(): optional, A function returning a bool which determines if this node should be visible. It can also return "ghost", which will hide the layer, but its node will still take up space in its tree.

  • branches: optional. An array of layer/node ids. On a tree, a line will appear from this node to all of the nodes in the list. Alternatively, an entry in the array can be a 2-element array consisting of the id and a color value. The color value can either be a string with a hex color code, or a number from 1-3 (theme-affected colors).

  • nodeStyle: optional. A CSS object, where the keys are CSS attributes, which styles this node on the tree.

  • tooltip() / tooltipLocked(): optional. Functions that return text, which is the tooltip for the node when the layer is unlocked or locked, respectively. By default the tooltips behave the same as in the original Prestige Tree.

  • row: optional, the row that this node appears in (for the default tree).

  • position: optional, Determines the horizontal position of the layer in its row in a default tree. By default, it uses the id, and layers/nodes are sorted in alphabetical order.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/updating-tmt.html b/public/lit/docs/updating-tmt.html index e90ef951..13af019e 100644 --- a/public/lit/docs/updating-tmt.html +++ b/public/lit/docs/updating-tmt.html @@ -26,7 +26,7 @@

Appearance

Updating The Modding Tree ​

This tutorial assumes that you have used the Getting Started Tutorial, and are using Github Desktop and VSCode for your mod.

Here's what you have to do when there's a TMT update:

  1. Look at the changelog. It will warn you if the update will break anything or require any changes. Decide if you want to try to update.

  2. Open Github Desktop, and at the top middle, click "fetch origin". This will make Github Desktop get information about the update.

  3. Click where it says "current branch: master" at the top middle, and at the bottom of the thing that appears, click "choose a branch to merge into master".

  4. Select upstream/master. It will likely say there are conflicts, but you have tools to resolve them. Click "Merge upstream/master into master".

  5. A conflict happens when the things you're trying to merge have both made changes in the same place. Click "open in Visual Studio Code" next to the first file.

  6. Scroll down through the file, and look for the parts highlighted in red and green. One of these is your code, and the other is some code that will be modified by the update. Do your best to try to edit things to keep the updated changes, but keep your content.

  7. Continue to do this for all remaining changes.

  8. Do any other changes required by the update, run the game, fix issues, etc.

Last updated:

- + \ No newline at end of file diff --git a/public/lit/docs/upgrades.html b/public/lit/docs/upgrades.html index 5cbd74b5..9d73ea3f 100644 --- a/public/lit/docs/upgrades.html +++ b/public/lit/docs/upgrades.html @@ -44,7 +44,7 @@ }, etc }

Each upgrade should have an id where the first digit is the row and the second digit is the column.

Individual upgrades can have these features:

  • title: optional. Displayed at the top in a larger font. It can also be a function that returns updating text. Can use basic HTML.

  • description: A description of the upgrade's effect. You will also have to implement the effect where it is applied. It can also be a function that returns updating text. Can use basic HTML.

  • effect(): optional. A function that calculates and returns the current values of any bonuses from the upgrade. Can return a value or an object containing multiple values.

  • effectDisplay(): optional. A function that returns a display of the current effects of the upgrade with formatting. Default displays nothing. Can use basic HTML.

  • fullDisplay(): OVERRIDE. Overrides the other displays and descriptions, and lets you set the full text for the upgrade. Can use basic HTML.

  • cost: A Decimal for the cost of the upgrade. By default, upgrades cost the main prestige currency for the layer.

  • unlocked(): optional. A function returning a bool to determine if the upgrade is visible or not. Default is unlocked.

  • onPurchase(): optional. This function will be called when the upgrade is purchased. Good for upgrades like "makes this layer act like it was unlocked first".

  • style: optional. Applies CSS to this upgrade, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).

  • layer: assigned automagically. It's the same value as the name of this layer, so you can do player[this.layer].points or similar.

  • id: assigned automagically. It's the "key" which the upgrade was stored under, for convenient access. The upgrade in the example's id is 11.

By default, upgrades use the main prestige currency for the layer. You can include these to change them (but it needs to be a Decimal):

  • currencyDisplayName: optional. The name to display for the currency for the upgrade.

  • currencyInternalName: optional. The internal name for that currency.

  • currencyLayer: optional. The internal name of the layer that currency is stored in. If it's not in a layer (like Points), omit. If it's not stored directly in a layer, instead use the next feature.

  • currencyLocation: optional. If your currency is stored in something inside a layer (e.g. a buyable's amount), you can access it this way. This is a function returning the object in "player" that contains the value (like player[this.layer].buyables)

If you want to do something more complicated like upgrades that cost two currencies, you can override the purchase system with these (and you need to use fullDisplay as well)

  • canAfford(): OVERRIDE, a function determining if you are able to buy the upgrade

  • pay(): OVERRIDE, a function that reduces your currencies when you buy the upgrade

Last updated:

- + \ No newline at end of file