Skip to content

Latest commit

 

History

History

README.md

storagotchi

Plugin - Storagotchi

This app is meant to be a cute semi-interactable entity to play with in the background. Support your Storagotchi by performing storage related tasks!

Features

* = doing later

  • Storagotchi
    • *happiness / energy level based on recent activity
    • animated
  • Environment
    • *Buildable, points from storage actions
  • *stream changes to state via websocket
  • Notifications
    • *If enabled, notify thru browser when things happen and state changes
  • *Achievements
    • achievement ideas:
      • first image
      • first storage block
      • first storage block with parent
      • first item
      • first item of type
      • Have items of all types
      • # of objects
      • first transaction
  • *Command line control of the Storagotchi
    • list status
    • put away an item
    • other?

Game Mechanics

  • Initial state:
    • boxes around the page
    • Some items smattered around
    • Storagotchi in center
    • calculated number of items lying around for the number of OQM inventory actions taken recently
    • *Scoreboard blank
  • *IMS Scoreboard
    • Shows inventory statistics
      • # blocks, items, stored
      • rates of inventory actions taken recently
  • Storagotchi:
    • at start:
      • wakes up, updates scoreboard
    • goes to boxes, picks things up, carries them around
    • drops said items randomly
    • *gets overwhelmed when too cluttered (too many items on screen)
    • *receives messages on how IRL storage work is going
      • Updates scoreboard when received (after completing current action)
      • gets inspired by your inventory actions, cleans up one item per action
      • received over websocket
    • *does something fun when clicked
  • Boxes:
    • jump / move slightly when clicked
    • "give" items to Storagotchi
    • *"take" items from Storagotchi
  • stuff
    • *wiggles when clicked
    • Sits around
    • Rarity scale on what gets pulled out of boxes

Credits

Resources from:

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./gradlew quarkusDev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using:

./gradlew build

It produces the quarkus-run.jar file in the build/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the build/quarkus-app/lib/ directory.

The application is now runnable using java -jar build/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./gradlew build -Dquarkus.package.jar.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar build/*-runner.jar.

Creating a native executable

You can create a native executable using:

./gradlew build -Dquarkus.native.enabled=true

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./gradlew build -Dquarkus.native.enabled=true -Dquarkus.native.container-build=true

You can then execute your native executable with: ./build/storagotchi-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/gradle-tooling.

Related Guides

  • REST (guide): A Jakarta REST implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
  • Hibernate Validator (guide): Validate object properties (field, getter) and method parameters for your beans (REST, CDI, Jakarta Persistence)
  • Qute (guide): Offer templating support for web, email, etc in a build time, type-safe way
  • Hibernate ORM with Panache (guide): Simplify your persistence code for Hibernate ORM via the active record or the repository pattern

Provided Code

Hibernate ORM

Create your first JPA entity

Related guide section...

Related Hibernate with Panache section...

REST

Easily start your REST Web Services

Related guide section...