Skip to content
KartofellFirstPublic

About

「ホ ト エ」.

Resources

Stars

5 stars

Watchers

0 watching

Forks

Latest commit

 

History

148 Commits

Folders and files

Repository files navigation

Hotoe logo
The main repo of every Hotoe Engine.

header-logo

Available platforms:

Core concept

Despite the normal applications, widgets creation starts from the frontend and deserves a frontend-first language — such as HTML.

Important

Quick terminology guide:
EWA — Enhanced Web Application (PWA analogy)
⤷ HUDs, menus, bars, floating widgets, etc.

Hotoe is a quickshell alternative, built for fast creation and prototyping of the EWAs between operating systems.

Features:

  • Minimalistic JS API (Enough to build basic widgets (update system state values, open apps, execute scripts))
  • If you need one, connect any backend you want to your project in 2 lines. (We don’t require specific language like Node/Rust/C, connect any using IPC)
  • Real 1 minute quick start followed by further advices to improve your ideas
  • The biggest community (Number of people who know HTML is 10s if not 100s times bigger than people who knows QML. It is way more likely to find contributors with Hotoe)
  • Save time (Coding with fine-tuned high-level languages saves weeks of time (especially for newbies) and helps prototyping. That is why people choose Python over C/C++)

Popular questions -> here
Pages version of the repo -> link

Quick start

Requirements:

ONE minute separates you from your Hello World app

Take your HTML frontend from whatever web app you have or use this default VSCode template below

I don’t understand It's fine, follow step by step:
0. Make sure hotoe CLI is installed and working on your device 1. Create a folder for your project somewhere, to keep files organized
2. Create a file named index.html in this folder
3. Right-click it and open with your text editor (not browser)
4. Paste the text from the template below into it and follow further steps
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <h1>Hello World!</h1>
</body>
</html>

Add SIR at the end of the <body> tag. And CLOSE() somewhere:
CLOSE() to close the application. SIR - Set as Input Region. Minimal requirements for every application: at least one way to close it + area to interact with it

<body SIR> <!-- this should do -->
    <h1 onclick="CLOSE()">Hello World!</h1>
</body>

Save and run this in your project's folder:

hotoe run

Done!
If you have figured out how to close it (click the "Hello World!" text if don't), I think we can finish this quickstart right here.
For further instructions check API docs or give it to your agent to study.
You can also see our projects gallery

Our next recommendation will be:
Limit your body's width and height

<body style="max-width: 50%; max-height: 30%;" SIR>

and

Read the manners list

  1. EWA does not cover full screen for a long time without giving user an opportunity to temporarily hide it or collapse it into something small —

    Your application has an advantage of user's system. It's above everything. As the carriers of such responsibility, we should always give user a choice.

  2. EWA preferably is not managing external applications lifecycle. We always try to keep content on the surface (inside the box we've been given)

    Exceptions: app launchers, docks or every other application whose main purpose is to help opening external windowed software or webpages.

  3. EWA does not interact with the WM.

    Leave it to normal apps. If you want a normal window use other frameworks.
    Things like exclusive zone are not allowed too (if you even know what is it). Think of a EWA more like a guest in user's system.

  4. Everything that can be localized must be localized

    To keep your application snappy, sources must be pre-loaded. Ideally, your application has to be able to open offline.

  5. No embedded content should have access to the API

    The only rule that secures your application. You must open external links in user's standard browser where they are sandboxed.
    Things like JS libraries and iframe content better be pre-loaded, so no one can inject fxAPI calls into them unnoticed.

  6. EWA decides itself how its UI looks. EWA's shapes are not necessarily rectangular. Minimize button might collapse, close button might minimize. We dont style your application with frames, dont tile them. We fight for EWA's beauty being untouched and we appreciate artists that bring life in their rises with our framework. Don’t be scared of making something unusual.


Welcome to the community!~



Contributing

We are always open to new ideas, bug reports, and contributions! If you want to help build the EWA ecosystem, feel free to submit a Pull Request or open an Issue.

Everyone who helps with the project get added to NOTICE



License

This project is licensed under the MIT License



$${\color{gray}\sim\ With\ love\ from\ Hotoe\ Team\ \sim}$$

About

「ホ ト エ」.

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages