Project Configuration
ArcOS v7 projects have a bunch of options you can change to fine-tune both your app, as well as your development experience. There are two files of note here: project.arc.json
and src/_app.tpa
. Here's what can be configured:
project.arc.json
Metadata
name
: The name of your packagedescription
: your package's descriptionauthor
: who made the appversion
: the version of your appinstallLocation
: where ArcOS is supposed to install this appappId
: the ID of your app. Be sure to also change it inoutFile
,.gitignore
and_app.tpa
.
outFile
: the resulting built app package from npx v7cli buildpayloadDir
: the directory containing the source files of your app.devPort
: the port that the development server uses.buildHash
: The ArcOS build that the type definitions originate from. I don't recommend changing this, it'll change when you runnpx v7cli update
.noHotRelaunch
: set this to true to stop the app from automatically relaunching if you make a change in your code.logLevel
: how many ArcOS logs to echo in the terminal. Default isnone
. Set it toprocess
to log logs relevant to your app's process, orall
to log everything.
_app.tpa
metadata
name
: The name of your appversion
: your app's versionauthor
: who made the appicon
: what icon to use. Prepend it with@local:
to reference an image file in the current directory, for example:@local:apples.png
position
:centered
: is the window centered on the screen?x
andy
: if not, use these pixel coordinates
size
: the default width and height of the appminSize
: the minimal width and height of the appmaxSize
: the maximal width and height of the appstate
:minimized
: is the window minimized by default?maximized
: is the window maximizedby default?headless
: does the window have no titlebar?resizable
: is the window resizable by the user?fullscreen
: is the window in fullscreen mode?
controls
:minimize
: show the minimize button?maximize
: show the maximize button?close
: show the close button?
glass
: enable glass effects?hidden
: hide this app from app lists like the start menu?core
: FOR ADVANCED USERS - This option disables the window controls, styling, basically any control ArcOS styling has over the window. It's a fullscreen app with zero supportive CSS, like the boot, login and initial setup screens.
You've probably read this before, but still, if there's anything wrong or unclear, reach out and I can help!
Last updated