Add MPL-2.0 & asset licenses; expand README
Add a full Mozilla Public License v2.0 (LICENSE) and a new ASSETS-LICENSE.md that clarifies Nebula branding, artwork, and other non-code assets are not covered by MPL and are All Rights Reserved unless stated otherwise. Update README.md with a detailed project overview: CEF migration, project status, goals, distribution direction, planned features, architecture notes, build instructions, and explicit licensing guidance separating source code (MPL-2.0) from branding assets and documentation.
This commit is contained in:
@@ -0,0 +1,11 @@
|
||||
# Nebula Browser Asset License
|
||||
|
||||
The source code of Nebula Browser is licensed under the Mozilla Public License 2.0, as described in the LICENSE file.
|
||||
|
||||
However, the Nebula Browser name, logo, icons, artwork, screenshots, visual identity, branding materials, and other non-code assets are not automatically covered by the MPL-2.0 license.
|
||||
|
||||
Unless otherwise stated, these assets are All Rights Reserved.
|
||||
|
||||
You may not use the Nebula Browser name, logo, or branding in a way that suggests endorsement, official status, or affiliation with the Nebula Project without permission.
|
||||
|
||||
Community forks are welcome, but they should use their own name and branding unless permission is granted.
|
||||
@@ -0,0 +1,373 @@
|
||||
Mozilla Public License Version 2.0
|
||||
==================================
|
||||
|
||||
1. Definitions
|
||||
--------------
|
||||
|
||||
1.1. "Contributor"
|
||||
means each individual or legal entity that creates, contributes to
|
||||
the creation of, or owns Covered Software.
|
||||
|
||||
1.2. "Contributor Version"
|
||||
means the combination of the Contributions of others (if any) used
|
||||
by a Contributor and that particular Contributor's Contribution.
|
||||
|
||||
1.3. "Contribution"
|
||||
means Covered Software of a particular Contributor.
|
||||
|
||||
1.4. "Covered Software"
|
||||
means Source Code Form to which the initial Contributor has attached
|
||||
the notice in Exhibit A, the Executable Form of such Source Code
|
||||
Form, and Modifications of such Source Code Form, in each case
|
||||
including portions thereof.
|
||||
|
||||
1.5. "Incompatible With Secondary Licenses"
|
||||
means
|
||||
|
||||
(a) that the initial Contributor has attached the notice described
|
||||
in Exhibit B to the Covered Software; or
|
||||
|
||||
(b) that the Covered Software was made available under the terms of
|
||||
version 1.1 or earlier of the License, but not also under the
|
||||
terms of a Secondary License.
|
||||
|
||||
1.6. "Executable Form"
|
||||
means any form of the work other than Source Code Form.
|
||||
|
||||
1.7. "Larger Work"
|
||||
means a work that combines Covered Software with other material, in
|
||||
a separate file or files, that is not Covered Software.
|
||||
|
||||
1.8. "License"
|
||||
means this document.
|
||||
|
||||
1.9. "Licensable"
|
||||
means having the right to grant, to the maximum extent possible,
|
||||
whether at the time of the initial grant or subsequently, any and
|
||||
all of the rights conveyed by this License.
|
||||
|
||||
1.10. "Modifications"
|
||||
means any of the following:
|
||||
|
||||
(a) any file in Source Code Form that results from an addition to,
|
||||
deletion from, or modification of the contents of Covered
|
||||
Software; or
|
||||
|
||||
(b) any new file in Source Code Form that contains any Covered
|
||||
Software.
|
||||
|
||||
1.11. "Patent Claims" of a Contributor
|
||||
means any patent claim(s), including without limitation, method,
|
||||
process, and apparatus claims, in any patent Licensable by such
|
||||
Contributor that would be infringed, but for the grant of the
|
||||
License, by the making, using, selling, offering for sale, having
|
||||
made, import, or transfer of either its Contributions or its
|
||||
Contributor Version.
|
||||
|
||||
1.12. "Secondary License"
|
||||
means either the GNU General Public License, Version 2.0, the GNU
|
||||
Lesser General Public License, Version 2.1, the GNU Affero General
|
||||
Public License, Version 3.0, or any later versions of those
|
||||
licenses.
|
||||
|
||||
1.13. "Source Code Form"
|
||||
means the form of the work preferred for making modifications.
|
||||
|
||||
1.14. "You" (or "Your")
|
||||
means an individual or a legal entity exercising rights under this
|
||||
License. For legal entities, "You" includes any entity that
|
||||
controls, is controlled by, or is under common control with You. For
|
||||
purposes of this definition, "control" means (a) the power, direct
|
||||
or indirect, to cause the direction or management of such entity,
|
||||
whether by contract or otherwise, or (b) ownership of more than
|
||||
fifty percent (50%) of the outstanding shares or beneficial
|
||||
ownership of such entity.
|
||||
|
||||
2. License Grants and Conditions
|
||||
--------------------------------
|
||||
|
||||
2.1. Grants
|
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||
non-exclusive license:
|
||||
|
||||
(a) under intellectual property rights (other than patent or trademark)
|
||||
Licensable by such Contributor to use, reproduce, make available,
|
||||
modify, display, perform, distribute, and otherwise exploit its
|
||||
Contributions, either on an unmodified basis, with Modifications, or
|
||||
as part of a Larger Work; and
|
||||
|
||||
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
||||
for sale, have made, import, and otherwise transfer either its
|
||||
Contributions or its Contributor Version.
|
||||
|
||||
2.2. Effective Date
|
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution
|
||||
become effective for each Contribution on the date the Contributor first
|
||||
distributes such Contribution.
|
||||
|
||||
2.3. Limitations on Grant Scope
|
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under
|
||||
this License. No additional rights or licenses will be implied from the
|
||||
distribution or licensing of Covered Software under this License.
|
||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||
Contributor:
|
||||
|
||||
(a) for any code that a Contributor has removed from Covered Software;
|
||||
or
|
||||
|
||||
(b) for infringements caused by: (i) Your and any other third party's
|
||||
modifications of Covered Software, or (ii) the combination of its
|
||||
Contributions with other software (except as part of its Contributor
|
||||
Version); or
|
||||
|
||||
(c) under Patent Claims infringed by Covered Software in the absence of
|
||||
its Contributions.
|
||||
|
||||
This License does not grant any rights in the trademarks, service marks,
|
||||
or logos of any Contributor (except as may be necessary to comply with
|
||||
the notice requirements in Section 3.4).
|
||||
|
||||
2.4. Subsequent Licenses
|
||||
|
||||
No Contributor makes additional grants as a result of Your choice to
|
||||
distribute the Covered Software under a subsequent version of this
|
||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||
permitted under the terms of Section 3.3).
|
||||
|
||||
2.5. Representation
|
||||
|
||||
Each Contributor represents that the Contributor believes its
|
||||
Contributions are its original creation(s) or it has sufficient rights
|
||||
to grant the rights to its Contributions conveyed by this License.
|
||||
|
||||
2.6. Fair Use
|
||||
|
||||
This License is not intended to limit any rights You have under
|
||||
applicable copyright doctrines of fair use, fair dealing, or other
|
||||
equivalents.
|
||||
|
||||
2.7. Conditions
|
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
||||
in Section 2.1.
|
||||
|
||||
3. Responsibilities
|
||||
-------------------
|
||||
|
||||
3.1. Distribution of Source Form
|
||||
|
||||
All distribution of Covered Software in Source Code Form, including any
|
||||
Modifications that You create or to which You contribute, must be under
|
||||
the terms of this License. You must inform recipients that the Source
|
||||
Code Form of the Covered Software is governed by the terms of this
|
||||
License, and how they can obtain a copy of this License. You may not
|
||||
attempt to alter or restrict the recipients' rights in the Source Code
|
||||
Form.
|
||||
|
||||
3.2. Distribution of Executable Form
|
||||
|
||||
If You distribute Covered Software in Executable Form then:
|
||||
|
||||
(a) such Covered Software must also be made available in Source Code
|
||||
Form, as described in Section 3.1, and You must inform recipients of
|
||||
the Executable Form how they can obtain a copy of such Source Code
|
||||
Form by reasonable means in a timely manner, at a charge no more
|
||||
than the cost of distribution to the recipient; and
|
||||
|
||||
(b) You may distribute such Executable Form under the terms of this
|
||||
License, or sublicense it under different terms, provided that the
|
||||
license for the Executable Form does not attempt to limit or alter
|
||||
the recipients' rights in the Source Code Form under this License.
|
||||
|
||||
3.3. Distribution of a Larger Work
|
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice,
|
||||
provided that You also comply with the requirements of this License for
|
||||
the Covered Software. If the Larger Work is a combination of Covered
|
||||
Software with a work governed by one or more Secondary Licenses, and the
|
||||
Covered Software is not Incompatible With Secondary Licenses, this
|
||||
License permits You to additionally distribute such Covered Software
|
||||
under the terms of such Secondary License(s), so that the recipient of
|
||||
the Larger Work may, at their option, further distribute the Covered
|
||||
Software under the terms of either this License or such Secondary
|
||||
License(s).
|
||||
|
||||
3.4. Notices
|
||||
|
||||
You may not remove or alter the substance of any license notices
|
||||
(including copyright notices, patent notices, disclaimers of warranty,
|
||||
or limitations of liability) contained within the Source Code Form of
|
||||
the Covered Software, except that You may alter any license notices to
|
||||
the extent required to remedy known factual inaccuracies.
|
||||
|
||||
3.5. Application of Additional Terms
|
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support,
|
||||
indemnity or liability obligations to one or more recipients of Covered
|
||||
Software. However, You may do so only on Your own behalf, and not on
|
||||
behalf of any Contributor. You must make it absolutely clear that any
|
||||
such warranty, support, indemnity, or liability obligation is offered by
|
||||
You alone, and You hereby agree to indemnify every Contributor for any
|
||||
liability incurred by such Contributor as a result of warranty, support,
|
||||
indemnity or liability terms You offer. You may include additional
|
||||
disclaimers of warranty and limitations of liability specific to any
|
||||
jurisdiction.
|
||||
|
||||
4. Inability to Comply Due to Statute or Regulation
|
||||
---------------------------------------------------
|
||||
|
||||
If it is impossible for You to comply with any of the terms of this
|
||||
License with respect to some or all of the Covered Software due to
|
||||
statute, judicial order, or regulation then You must: (a) comply with
|
||||
the terms of this License to the maximum extent possible; and (b)
|
||||
describe the limitations and the code they affect. Such description must
|
||||
be placed in a text file included with all distributions of the Covered
|
||||
Software under this License. Except to the extent prohibited by statute
|
||||
or regulation, such description must be sufficiently detailed for a
|
||||
recipient of ordinary skill to be able to understand it.
|
||||
|
||||
5. Termination
|
||||
--------------
|
||||
|
||||
5.1. The rights granted under this License will terminate automatically
|
||||
if You fail to comply with any of its terms. However, if You become
|
||||
compliant, then the rights granted under this License from a particular
|
||||
Contributor are reinstated (a) provisionally, unless and until such
|
||||
Contributor explicitly and finally terminates Your grants, and (b) on an
|
||||
ongoing basis, if such Contributor fails to notify You of the
|
||||
non-compliance by some reasonable means prior to 60 days after You have
|
||||
come back into compliance. Moreover, Your grants from a particular
|
||||
Contributor are reinstated on an ongoing basis if such Contributor
|
||||
notifies You of the non-compliance by some reasonable means, this is the
|
||||
first time You have received notice of non-compliance with this License
|
||||
from such Contributor, and You become compliant prior to 30 days after
|
||||
Your receipt of the notice.
|
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent
|
||||
infringement claim (excluding declaratory judgment actions,
|
||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||
directly or indirectly infringes any patent, then the rights granted to
|
||||
You by any and all Contributors for the Covered Software under Section
|
||||
2.1 of this License shall terminate.
|
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
||||
end user license agreements (excluding distributors and resellers) which
|
||||
have been validly granted by You or Your distributors under this License
|
||||
prior to termination shall survive termination.
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 6. Disclaimer of Warranty *
|
||||
* ------------------------- *
|
||||
* *
|
||||
* Covered Software is provided under this License on an "as is" *
|
||||
* basis, without warranty of any kind, either expressed, implied, or *
|
||||
* statutory, including, without limitation, warranties that the *
|
||||
* Covered Software is free of defects, merchantable, fit for a *
|
||||
* particular purpose or non-infringing. The entire risk as to the *
|
||||
* quality and performance of the Covered Software is with You. *
|
||||
* Should any Covered Software prove defective in any respect, You *
|
||||
* (not any Contributor) assume the cost of any necessary servicing, *
|
||||
* repair, or correction. This disclaimer of warranty constitutes an *
|
||||
* essential part of this License. No use of any Covered Software is *
|
||||
* authorized under this License except under this disclaimer. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 7. Limitation of Liability *
|
||||
* -------------------------- *
|
||||
* *
|
||||
* Under no circumstances and under no legal theory, whether tort *
|
||||
* (including negligence), contract, or otherwise, shall any *
|
||||
* Contributor, or anyone who distributes Covered Software as *
|
||||
* permitted above, be liable to You for any direct, indirect, *
|
||||
* special, incidental, or consequential damages of any character *
|
||||
* including, without limitation, damages for lost profits, loss of *
|
||||
* goodwill, work stoppage, computer failure or malfunction, or any *
|
||||
* and all other commercial damages or losses, even if such party *
|
||||
* shall have been informed of the possibility of such damages. This *
|
||||
* limitation of liability shall not apply to liability for death or *
|
||||
* personal injury resulting from such party's negligence to the *
|
||||
* extent applicable law prohibits such limitation. Some *
|
||||
* jurisdictions do not allow the exclusion or limitation of *
|
||||
* incidental or consequential damages, so this exclusion and *
|
||||
* limitation may not apply to You. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
8. Litigation
|
||||
-------------
|
||||
|
||||
Any litigation relating to this License may be brought only in the
|
||||
courts of a jurisdiction where the defendant maintains its principal
|
||||
place of business and such litigation shall be governed by laws of that
|
||||
jurisdiction, without reference to its conflict-of-law provisions.
|
||||
Nothing in this Section shall prevent a party's ability to bring
|
||||
cross-claims or counter-claims.
|
||||
|
||||
9. Miscellaneous
|
||||
----------------
|
||||
|
||||
This License represents the complete agreement concerning the subject
|
||||
matter hereof. If any provision of this License is held to be
|
||||
unenforceable, such provision shall be reformed only to the extent
|
||||
necessary to make it enforceable. Any law or regulation which provides
|
||||
that the language of a contract shall be construed against the drafter
|
||||
shall not be used to construe this License against a Contributor.
|
||||
|
||||
10. Versions of the License
|
||||
---------------------------
|
||||
|
||||
10.1. New Versions
|
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section
|
||||
10.3, no one other than the license steward has the right to modify or
|
||||
publish new versions of this License. Each version will be given a
|
||||
distinguishing version number.
|
||||
|
||||
10.2. Effect of New Versions
|
||||
|
||||
You may distribute the Covered Software under the terms of the version
|
||||
of the License under which You originally received the Covered Software,
|
||||
or under the terms of any subsequent version published by the license
|
||||
steward.
|
||||
|
||||
10.3. Modified Versions
|
||||
|
||||
If you create software not governed by this License, and you want to
|
||||
create a new license for such software, you may create and use a
|
||||
modified version of this License if you rename the license and remove
|
||||
any references to the name of the license steward (except to note that
|
||||
such modified license differs from this License).
|
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||
Licenses
|
||||
|
||||
If You choose to distribute Source Code Form that is Incompatible With
|
||||
Secondary Licenses under the terms of this version of the License, the
|
||||
notice described in Exhibit B of this License must be attached.
|
||||
|
||||
Exhibit A - Source Code Form License Notice
|
||||
-------------------------------------------
|
||||
|
||||
This Source Code Form is subject to the terms of the Mozilla Public
|
||||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
|
||||
If it is not possible or desirable to put the notice in a particular
|
||||
file, then You may include the notice in a location (such as a LICENSE
|
||||
file in a relevant directory) where a recipient would be likely to look
|
||||
for such a notice.
|
||||
|
||||
You may add additional accurate notices of copyright ownership.
|
||||
|
||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||
---------------------------------------------------------
|
||||
|
||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||
defined by the Mozilla Public License, v. 2.0.
|
||||
@@ -2,11 +2,277 @@
|
||||
|
||||
A Chromium Embedded Framework (CEF) browser with a custom HTML chrome UI.
|
||||
|
||||
**Nebula Browser** is a controller-first web browser designed for Steam Deck, SteamOS-style systems, handheld PCs, living room setups, and gamepad-driven desktop environments.
|
||||
|
||||
Originally developed as an Electron-based browser for SteamOS users, Nebula Browser is now being rebuilt with **CEF / Chromium Embedded Framework** to provide deeper control over the browser experience, improved native integration, and a cleaner long-term foundation for custom UI, controller navigation, and platform-specific builds.
|
||||
|
||||
Development on Nebula Browser has somewhat resumed, with the project now moving toward a more native custom browser architecture.
|
||||
|
||||
Nebula Browser is intended to remain open source. The browser source code is licensed under MPL-2.0, while Nebula branding and visual assets are protected separately.
|
||||
|
||||
## Documentation
|
||||
|
||||
- **[Cross-platform build & architecture](docs/cross-platform.md)** — how to use one repo for Windows, macOS, and Linux; CEF setup; source layout; porting status.
|
||||
|
||||
## Quick start (Windows)
|
||||
---
|
||||
|
||||
## Project Status
|
||||
|
||||
Nebula Browser is currently in early active redevelopment.
|
||||
|
||||
The original Electron version proved the core idea: a browser built around controller use, large-screen navigation, and a UI that does not feel like a standard desktop browser awkwardly placed on a handheld gaming device.
|
||||
|
||||
The new CEF version is the next major step.
|
||||
|
||||
Current focus areas include:
|
||||
|
||||
* Rebuilding the browser around CEF
|
||||
* Creating a fully custom browser interface
|
||||
* Moving away from default Chromium UI elements
|
||||
* Reusing and adapting existing Nebula UI concepts where possible
|
||||
* Supporting controller-first navigation
|
||||
* Preparing for cross-platform builds across Windows, Linux, and macOS
|
||||
* Creating a stronger foundation for future NebulaOS integration
|
||||
|
||||
---
|
||||
|
||||
## Why CEF?
|
||||
|
||||
Nebula Browser originally used Electron because it was fast to prototype, easy to package, and allowed the project to move quickly. However, Electron also comes with limits when building a browser that is meant to feel fully custom and deeply integrated with the operating system.
|
||||
|
||||
The move to **CEF** allows Nebula Browser to become more than a web app wrapped in a browser shell.
|
||||
|
||||
CEF gives the project:
|
||||
|
||||
* More control over the native window and browser lifecycle
|
||||
* Better separation between the browser engine and the custom UI
|
||||
* Greater flexibility for building a non-Chrome-like interface
|
||||
* A more suitable foundation for SteamOS, Linux, and future NebulaOS use
|
||||
* The ability to build a browser that feels purpose-built rather than wrapped
|
||||
|
||||
The goal is not to create another Chromium clone. The goal is to create a browser interface designed around how people actually use handhelds, controllers, TVs, and gaming-first systems.
|
||||
|
||||
---
|
||||
|
||||
## Distribution Direction
|
||||
|
||||
Nebula Browser was originally aimed at Steam. However, after exploring Steam as a release platform, it became clear that Steam may not be the best fit for this kind of application.
|
||||
|
||||
The current distribution direction is:
|
||||
|
||||
### Primary Target
|
||||
|
||||
* **Itch.io**
|
||||
|
||||
Itch.io is currently the most practical and flexible platform for distributing Nebula Browser. It allows the project to be released as a utility-style app without needing to fit into a traditional game store category.
|
||||
|
||||
### Potential Future Targets
|
||||
|
||||
* **Epic Games Store**
|
||||
* **GOG**
|
||||
* **Flatpak / Linux package distribution**
|
||||
* **Direct downloads from the Nebula website**
|
||||
|
||||
Epic Games and GOG are being considered as possible future distribution platforms, especially if Nebula Browser grows into a more polished desktop or gaming utility. These are not confirmed release platforms yet, but they remain possible options.
|
||||
|
||||
---
|
||||
|
||||
## Open Source Direction
|
||||
|
||||
Nebula Browser is intended to remain open source because browsers are privacy-sensitive software. Users should be able to inspect how the browser works, verify that it is not doing anything suspicious, and contribute fixes or improvements when they find problems.
|
||||
|
||||
Open source is especially important for:
|
||||
|
||||
* User trust
|
||||
* Privacy transparency
|
||||
* Linux and Steam Deck community adoption
|
||||
* Cross-platform testing
|
||||
* Community contributions
|
||||
* Long-term sustainability
|
||||
|
||||
The core Nebula Browser project should remain open source, including:
|
||||
|
||||
* Browser shell
|
||||
* CEF integration code
|
||||
* Custom browser UI
|
||||
* Controller navigation systems
|
||||
* Settings and theme systems
|
||||
* Build scripts and documentation
|
||||
|
||||
Not every Nebula-related component has to be open source. Some future or external components may remain private or be licensed separately, such as:
|
||||
|
||||
* NebulaOS-specific services
|
||||
* Account systems
|
||||
* Cloud sync
|
||||
* Hosted backend services
|
||||
* Internal analytics or crash reporting infrastructure
|
||||
* Private distribution tooling
|
||||
* Experimental unreleased features
|
||||
* Protected branding assets
|
||||
|
||||
Suggested openness model:
|
||||
|
||||
```text
|
||||
Nebula Browser: open source
|
||||
Nebula Core: open source or source-available
|
||||
NebulaOS: potentially partially open source
|
||||
Nebula online services/backend: private
|
||||
Branding assets: protected
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Core Vision
|
||||
|
||||
Nebula Browser is built around one simple idea:
|
||||
|
||||
> The web should be comfortable to use from a couch, handheld, controller, or gaming-focused operating system.
|
||||
|
||||
Most browsers are designed around keyboards, mice, and desktop workflows. Nebula Browser is designed around a different experience.
|
||||
|
||||
Nebula Browser aims to support:
|
||||
|
||||
* Controller-first navigation
|
||||
* Large, readable interface elements
|
||||
* Gamepad-friendly menus and shortcuts
|
||||
* Steam Deck and handheld PC usability
|
||||
* Custom home pages and launcher-style navigation
|
||||
* Better integration with gaming-focused environments
|
||||
* A UI that feels closer to a console app than a traditional browser
|
||||
|
||||
---
|
||||
|
||||
## Planned Features
|
||||
|
||||
The CEF rebuild is still early, but the intended feature set includes:
|
||||
|
||||
* Fully custom browser chrome
|
||||
* Custom tab bar
|
||||
* Custom address bar
|
||||
* Controller-friendly navigation system
|
||||
* On-screen keyboard support
|
||||
* Bookmarks and quick access tiles
|
||||
* Custom home page
|
||||
* Desktop mode and controller mode
|
||||
* Fullscreen and couch-friendly browsing
|
||||
* Custom context menus
|
||||
* Download management
|
||||
* Settings system
|
||||
* Theme support
|
||||
* Steam Deck / handheld-focused layout options
|
||||
* Optional integration with NebulaOS
|
||||
|
||||
Some features may be ported or adapted from the earlier Electron version where it makes sense.
|
||||
|
||||
---
|
||||
|
||||
## Nebula Core
|
||||
|
||||
Nebula Browser may also make use of **Nebula Core**, a shared package system for Nebula-related projects.
|
||||
|
||||
Nebula Core is intended to provide reusable systems such as:
|
||||
|
||||
* Controller input handling
|
||||
* Navigation helpers
|
||||
* UI components
|
||||
* Glyphs and button prompts
|
||||
* Theming utilities
|
||||
* On-screen keyboard systems
|
||||
* Shared Nebula project logic
|
||||
|
||||
Because the new browser is CEF-based rather than Electron-based, some Nebula Core modules may need to be adapted for native integration or used through the browser UI layer rather than directly inside the C++ application layer.
|
||||
|
||||
---
|
||||
|
||||
## Relationship to NebulaOS
|
||||
|
||||
Nebula Browser is part of the wider **Nebula Project** ecosystem.
|
||||
|
||||
NebulaOS is a controller-focused operating system / shell concept designed around gaming, handheld PCs, and living room devices. Nebula Browser is intended to become one of the key built-in applications for that ecosystem.
|
||||
|
||||
While Nebula Browser can exist as a standalone app, its long-term role is to provide a web browsing experience that feels native inside NebulaOS.
|
||||
|
||||
---
|
||||
|
||||
## Technology Stack
|
||||
|
||||
The current redevelopment direction uses:
|
||||
|
||||
* **C++** for the native browser shell
|
||||
* **CEF / Chromium Embedded Framework** for web rendering
|
||||
* **HTML, CSS, and JavaScript** for the custom browser UI
|
||||
* **CMake** for project configuration
|
||||
* Platform-specific CEF builds for Windows, Linux, and macOS
|
||||
|
||||
The previous version used Electron, but the current direction is focused on CEF.
|
||||
|
||||
---
|
||||
|
||||
## Repository Structure
|
||||
|
||||
The repository structure may change as the CEF rebuild develops, but the project is expected to follow a layout similar to:
|
||||
|
||||
```text
|
||||
NebulaBrowser/
|
||||
├── app/
|
||||
│ ├── browser/
|
||||
│ ├── ui/
|
||||
│ └── platform/
|
||||
├── cef/
|
||||
│ └── README.md
|
||||
├── resources/
|
||||
│ ├── icons/
|
||||
│ ├── themes/
|
||||
│ └── pages/
|
||||
├── scripts/
|
||||
├── third_party/
|
||||
├── CMakeLists.txt
|
||||
└── README.md
|
||||
```
|
||||
|
||||
CEF itself should generally not be committed directly into the repository. Instead, platform-specific CEF builds should be downloaded separately and placed into the expected local folder during development.
|
||||
|
||||
---
|
||||
|
||||
## Development Notes
|
||||
|
||||
Nebula Browser is still experimental and in transition from the original Electron version to the new CEF version.
|
||||
|
||||
Expect changes in:
|
||||
|
||||
* Build setup
|
||||
* File structure
|
||||
* UI architecture
|
||||
* Controller input systems
|
||||
* Platform support
|
||||
* Packaging and distribution
|
||||
|
||||
The project is not yet considered production-ready.
|
||||
|
||||
---
|
||||
|
||||
## Building
|
||||
|
||||
Build instructions will be expanded as the CEF version becomes more stable.
|
||||
|
||||
At a high level, development requires:
|
||||
|
||||
1. A supported C++ compiler
|
||||
2. CMake
|
||||
3. A downloaded CEF binary distribution for your operating system
|
||||
4. The Nebula Browser source code
|
||||
5. A local build folder
|
||||
|
||||
Example build flow:
|
||||
|
||||
```bash
|
||||
cmake -S . -B build
|
||||
cmake --build build
|
||||
```
|
||||
|
||||
More detailed platform-specific instructions will be added later. For macOS/Linux prerequisites, directory structure, and current port status, see [docs/cross-platform.md](docs/cross-platform.md).
|
||||
|
||||
### Quick start (Windows)
|
||||
|
||||
1. Download the [CEF standard binary distribution](https://cef-builds.spotifycdn.com/index.html) for Windows 64-bit.
|
||||
2. Extract into `thirdparty/cef/` so `thirdparty/cef/cmake/FindCEF.cmake` exists.
|
||||
@@ -19,8 +285,67 @@ A Chromium Embedded Framework (CEF) browser with a custom HTML chrome UI.
|
||||
|
||||
4. Run `build\Release\NebulaBrowser.exe`.
|
||||
|
||||
For macOS/Linux prerequisites, directory structure, and current port status, see [docs/cross-platform.md](docs/cross-platform.md).
|
||||
---
|
||||
|
||||
## License
|
||||
## Platform Goals
|
||||
|
||||
Nebula Browser is being designed with cross-platform support in mind.
|
||||
|
||||
Target platforms include:
|
||||
|
||||
* Windows
|
||||
* Linux
|
||||
* SteamOS / Steam Deck
|
||||
* macOS
|
||||
|
||||
Linux and SteamOS are especially important because Nebula Browser was originally created to solve a gap in the handheld and couch-browsing experience.
|
||||
|
||||
---
|
||||
|
||||
## Release Plans
|
||||
|
||||
Nebula Browser does not currently have a fixed release date.
|
||||
|
||||
The current release plan is:
|
||||
|
||||
1. Rebuild the core browser shell in CEF
|
||||
2. Replace default Chromium UI with a custom Nebula interface
|
||||
3. Restore core browser functionality
|
||||
4. Add controller-first navigation
|
||||
5. Prepare an early public build
|
||||
6. Release through Itch.io first
|
||||
7. Explore additional distribution options later
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Nebula Browser is currently a personal / experimental project and is still finding its new technical direction.
|
||||
|
||||
Contributions, ideas, testing, and feedback may become more open once the CEF rebuild has a more stable foundation.
|
||||
|
||||
---
|
||||
|
||||
## Licensing
|
||||
|
||||
Nebula Browser separates source code licensing from branding and visual assets.
|
||||
|
||||
The preferred licensing direction is:
|
||||
|
||||
* **Source code:** Mozilla Public License 2.0
|
||||
* **Documentation:** CC BY 4.0, unless otherwise specified
|
||||
* **Branding, logos, icons, names, and visual identity:** All Rights Reserved, unless explicitly stated otherwise
|
||||
|
||||
MPL-2.0 is being used because it is a practical open-source license for a browser-style project. It allows people to use, modify, and contribute to the code while requiring changes to MPL-licensed files to remain open under the same license.
|
||||
|
||||
The Nebula name, logo, and brand identity are not automatically granted for reuse just because the code is open source. See [ASSETS-LICENSE.md](ASSETS-LICENSE.md) for the separate asset and branding terms.
|
||||
|
||||
See the CEF distribution and Chromium license terms for third-party runtime components.
|
||||
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
Nebula Browser is created as part of the wider Nebula Project, a collection of software experiments focused on controller-first computing, gaming-focused interfaces, and custom desktop experiences.
|
||||
|
||||
The project began as a browser for SteamOS and Steam Deck users, but is now evolving into a more flexible, native, and custom browser experience built around CEF.
|
||||
|
||||
Reference in New Issue
Block a user