Skip to content

A base widget that will wrap the JappeOS desktop and greeter. Enables window management and multi-display support.

License

Notifications You must be signed in to change notification settings

JappeOS/jappeos_desktop_base

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


jappeos_desktop_base

Contains base widgets and tools used by the greeter and the desktop environment.


Overview

Mainly provides a widget that is used to wrap the desktop environment or greeter. This widget allows easy integration of window management and other parts with multi-display support.

Features

  • Window manager implementation
  • Window manager background and overlay layers
  • Multi-display support

Role in the OS

Used by the desktop and greeter.

Building

Prerequisites

  • Flutter SDK 3.38.0 or later (with desktop support enabled)
  • Dart SDK (included with Flutter)

Verify Flutter desktop setup:

$ flutter doctor

Setup

Clone the repository and fetch dependencies:

$ git clone https://github.com/JappeOS/jappeos_desktop_base.git
$ cd jappeos_desktop_base
$ flutter pub get

Build

Important

This project is meant to be used as a library through pubspec, and cannot be ran locally. If you need to test it, create another Dart or Flutter project and add it as a dependency.

Linux

$ flutter build linux

This produces a binary in:

build/linux/x64/release/bundle/

Run locally:

$ flutter run -d linux

Other platforms

While running on Linux is recommended, you can still build and run on other platforms. Just use the above instructions, and replace linux with the platform name (e.g. windows or macos).

Build Modes

  • debug - default for development
  • profile - performance testing
  • release - production build

Example:

$ flutter build linux --release

Troubleshooting

If the build fails after dependency changes:

$ flutter clean
$ flutter pub get

Check flutter doctor for missing desktop dependencies.

Contributing

Contributions of all kinds are welcome and appreciated. You can help the project by:

  • ⭐ Starring the repository to show your support
  • 💖 Sponsoring the project (if available)
  • 🐞 Reporting bugs via GitHub Issues
  • 💡 Requesting or discussing new features

For code contributions, please see CONTRIBUTING.md for guidelines.

License

This repository is part of the JappeOS project and is licensed under the terms described in the LICENSE file.

About

A base widget that will wrap the JappeOS desktop and greeter. Enables window management and multi-display support.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages