Visualize Your Ideas With Code
feat: application settings (#697)
Jacob54016f5cf350
diff --git a/packages/core/src/app/Project.ts b/packages/core/src/app/Project.tsindex d408eab6..a67ea1ca 100644--- a/packages/core/src/app/Project.ts+++ b/packages/core/src/app/Project.ts@@ -2,6 +2,7 @@ import {FullSceneDescription} from '../scenes';import {Logger} from './Logger';import type {ProjectMetadata} from './ProjectMetadata';import type {Plugin} from '../plugin';+import {SettingsMetadata} from './SettingsMetadata';export interface ProjectSettings {name?: string;@@ -29,6 +30,7 @@ export interface Project {plugins: Plugin[];logger: Logger;meta: ProjectMetadata;+ settings: SettingsMetadata;audio?: string;variables?: Record<string, unknown>;versions: Versions;diff --git a/packages/core/src/app/SettingsMetadata.ts b/packages/core/src/app/SettingsMetadata.tsnew file mode 100644index 00000000..ff4438fb--- /dev/null+++ b/packages/core/src/app/SettingsMetadata.ts@@ -0,0 +1,39 @@+import {+ BoolMetaField,+ ColorMetaField,+ MetaField,+ ObjectMetaField,+ Vector2MetaField,+} from '../meta';+import {Vector2, Color} from '../types';++/**+ * Create a runtime representation of the settings metadata.+ */+export function createSettingsMetadata() {+ return new ObjectMetaField('Application Settings', {+ version: new MetaField('version', 1),+ appearance: new ObjectMetaField('Appearance', {+ color: new ColorMetaField('accent color', new Color('#33a6ff')).describe(+ 'The accent color for the user interface. (Leave empty to use the default color)',+ ),+ font: new BoolMetaField('legacy font', false).describe(+ "Use the 'JetBrains Mono' font for the user interface.",+ ),+ }),+ defaults: new ObjectMetaField('Defaults', {+ background: new ColorMetaField('background', null).describe(+ 'The default background color used in new projects.',+ ),+ size: new Vector2MetaField(+ 'resolution',+ new Vector2(1920, 1080),+ ).describe('The default resolution used in new projects.'),+ }),+ });+}++/**+ * A runtime representation of the settings metadata.+ */+export type SettingsMetadata = ReturnType<typeof createSettingsMetadata>;diff --git a/packages/core/src/app/bootstrap.ts b/packages/core/src/app/bootstrap.tsindex aa8a89a8..03ffcc0b 100644--- a/packages/core/src/app/bootstrap.ts+++ b/packages/core/src/app/bootstrap.ts@@ -3,6 +3,7 @@ import {Project, ProjectSettings, Versions} from './Project';import {ProjectMetadata} from './ProjectMetadata';import {Plugin} from '../plugin';import {MetaFile} from '../meta';+import {createSettingsMetadata} from './SettingsMetadata';/*** Bootstrap a project.@@ -10,8 +11,9 @@ import {MetaFile} from '../meta';* @param name - The name of the project.* @param versions - Package versions.* @param plugins - Loaded plugins.- * @param settings - Project settings.- * @param metaFile - The meta file.+ * @param config - Project settings.+ * @param metaFile - The project meta file.+ * @param settingsFile - The settings meta file.** @internal*/@@ -19,22 +21,28 @@ export function bootstrap(name: string,versions: Versions,plugins: Plugin[],- settings: ProjectSettings,+ config: ProjectSettings,metaFile: MetaFile<any>,+ settingsFile: MetaFile<any>,): Project {+ const settings = createSettingsMetadata();+ settingsFile.attach(settings);+const reducedSettings = plugins.reduce((settings, plugin) => ({...settings,...(plugin.settings?.(settings) ?? {}),}),- {name, ...settings} as ProjectSettings,+ {name, ...config} as ProjectSettings,);const project = {...reducedSettings} as Project;project.versions = versions;project.logger = new Logger();project.plugins = plugins;+ project.settings = settings;project.meta = new ProjectMetadata(project);+ project.meta.shared.set(settings.defaults.get());metaFile.attach(project.meta);plugins.forEach(plugin => plugin.project?.(project));diff --git a/packages/core/src/app/index.ts b/packages/core/src/app/index.tsindex 64a40dbc..414cccce 100644--- a/packages/core/src/app/index.ts+++ b/packages/core/src/app/index.ts@@ -15,4 +15,5 @@ export * from './Presenter';export * from './Project';export * from './ProjectMetadata';export * from './Renderer';+export * from './SettingsMetadata';export * from './Stage';diff --git a/packages/core/src/meta/MetaField.ts b/packages/core/src/meta/MetaField.tsindex 0f5119aa..f058baa6 100644--- a/packages/core/src/meta/MetaField.ts+++ b/packages/core/src/meta/MetaField.ts@@ -42,10 +42,13 @@ export class MetaField</*** @param name - The name of this field displayed in the editor.- * @param value - The initial value of this field.+ * @param initial - The initial value of this field.*/- public constructor(public readonly name: string, value: TValue) {- this.value = new ValueDispatcher(value);+ public constructor(+ public readonly name: string,+ public readonly initial: TValue,+ ) {+ this.value = new ValueDispatcher(initial);}/**diff --git a/packages/core/src/meta/ObjectMetaField.ts b/packages/core/src/meta/ObjectMetaField.tsindex 46f76243..3067f89f 100644--- a/packages/core/src/meta/ObjectMetaField.ts+++ b/packages/core/src/meta/ObjectMetaField.ts@@ -57,7 +57,7 @@ class ObjectMetaFieldInternal<}}- public override set(value: ValueOf<T>) {+ public override set(value: Partial<ValueOf<T>>) {this.ignoreChange = true;for (const [key, fieldValue] of Object.entries(value)) {const field = this.fields.get(key);diff --git a/packages/core/src/signals/SignalContext.ts b/packages/core/src/signals/SignalContext.tsindex f49b824a..213c92b9 100644--- a/packages/core/src/signals/SignalContext.ts+++ b/packages/core/src/signals/SignalContext.ts@@ -178,7 +178,7 @@ export class SignalContext<const initial = this.get();const queue: ThreadGenerator[] = [];- const task = run(function* animate() {+ const task = run('animation chain', function* animate() {while (queue.length > 0) {yield* queue.shift()!;}diff --git a/packages/ui/src/Editor.tsx b/packages/ui/src/Editor.tsxindex 7c07cdd2..216eaa4f 100644--- a/packages/ui/src/Editor.tsx+++ b/packages/ui/src/Editor.tsx@@ -7,7 +7,12 @@ import {PresentationMode} from './components/presentation';import {EditorPanel, BottomPanel, SidebarPanel} from './signals';import {Timeline} from './components/timeline';import {Console} from './components/console';-import {Properties, Threads, VideoSettings} from './components/sidebar';+import {+ Properties,+ Settings,+ Threads,+ VideoSettings,+} from './components/sidebar';import styles from './Editor.module.scss';export function Editor() {@@ -34,6 +39,7 @@ export function Editor() {[EditorPanel.Inspector]: Properties,[EditorPanel.Threads]: Threads,[EditorPanel.Console]: Console,+ [EditorPanel.Settings]: Settings,}}/><Viewport />diff --git a/packages/ui/src/Index.module.scss b/packages/ui/src/Index.module.scssindex 8080585c..79d51557 100644--- a/packages/ui/src/Index.module.scss+++ b/packages/ui/src/Index.module.scss@@ -39,7 +39,6 @@}.title {- padding-bottom: 4px;color: rgba(255, 255, 255, 0.6);}diff --git a/packages/ui/src/components/icons/Settings.tsx b/packages/ui/src/components/icons/Settings.tsxnew file mode 100644index 00000000..e472feef--- /dev/null+++ b/packages/ui/src/components/icons/Settings.tsx@@ -0,0 +1,7 @@+export function Settings() {+ return (+ <svg viewBox="0 0 24 24" fill="currentColor">+ <path d="M19.43 12.98c.04-.32.07-.64.07-.98 0-.34-.03-.66-.07-.98l2.11-1.65c.19-.15.24-.42.12-.64l-2-3.46c-.09-.16-.26-.25-.44-.25-.06 0-.12.01-.17.03l-2.49 1c-.52-.4-1.08-.73-1.69-.98l-.38-2.65C14.46 2.18 14.25 2 14 2h-4c-.25 0-.46.18-.49.42l-.38 2.65c-.61.25-1.17.59-1.69.98l-2.49-1c-.06-.02-.12-.03-.18-.03-.17 0-.34.09-.43.25l-2 3.46c-.13.22-.07.49.12.64l2.11 1.65c-.04.32-.07.65-.07.98 0 .33.03.66.07.98l-2.11 1.65c-.19.15-.24.42-.12.64l2 3.46c.09.16.26.25.44.25.06 0 .12-.01.17-.03l2.49-1c.52.4 1.08.73 1.69.98l.38 2.65c.03.24.24.42.49.42h4c.25 0 .46-.18.49-.42l.38-2.65c.61-.25 1.17-.59 1.69-.98l2.49 1c.06.02.12.03.18.03.17 0 .34-.09.43-.25l2-3.46c.12-.22.07-.49-.12-.64l-2.11-1.65zm-1.98-1.71c.04.31.05.52.05.73 0 .21-.02.43-.05.73l-.14 1.13.89.7 1.08.84-.7 1.21-1.27-.51-1.04-.42-.9.68c-.43.32-.84.56-1.25.73l-1.06.43-.16 1.13-.2 1.35h-1.4l-.19-1.35-.16-1.13-1.06-.43c-.43-.18-.83-.41-1.23-.71l-.91-.7-1.06.43-1.27.51-.7-1.21 1.08-.84.89-.7-.14-1.13c-.03-.31-.05-.54-.05-.74s.02-.43.05-.73l.14-1.13-.89-.7-1.08-.84.7-1.21 1.27.51 1.04.42.9-.68c.43-.32.84-.56 1.25-.73l1.06-.43.16-1.13.2-1.35h1.39l.19 1.35.16 1.13 1.06.43c.43.18.83.41 1.23.71l.91.7 1.06-.43 1.27-.51.7 1.21-1.07.85-.89.7.14 1.13zM12 8c-2.21 0-4 1.79-4 4s1.79 4 4 4 4-1.79 4-4-1.79-4-4-4zm0 6c-1.1 0-2-.9-2-2s.9-2 2-2 2 .9 2 2-.9 2-2 2z" />+ </svg>+ );+}diff --git a/packages/ui/src/components/icons/index.ts b/packages/ui/src/components/icons/index.tsindex 892935ba..68662986 100644--- a/packages/ui/src/components/icons/index.ts+++ b/packages/ui/src/components/icons/index.ts@@ -18,6 +18,7 @@ export * from './PlayArrow';export * from './Recenter';export * from './Repeat';export * from './Schedule';+export * from './Settings';export * from './SkipNext';export * from './SkipPrevious';export * from './Tune';diff --git a/packages/ui/src/components/layout/Navigation.tsx b/packages/ui/src/components/layout/Navigation.tsxindex e52be96a..9fcbcd30 100644--- a/packages/ui/src/components/layout/Navigation.tsx+++ b/packages/ui/src/components/layout/Navigation.tsx@@ -10,6 +10,7 @@ import {Docs,MotionCanvas,Movie,+ Settings,Videocam,ViewTimeline,} from '../icons';@@ -90,6 +91,9 @@ export function Navigation() {</Badge>)}</Tab>+ <Tab title="Settings" id="settings-tab" tab={EditorPanel.Settings}>+ <Settings />+ </Tab></TabGroup><Space /><TabLinkdiff --git a/packages/ui/src/components/layout/ResizeableLayout.module.scss b/packages/ui/src/components/layout/ResizeableLayout.module.scssindex 4058b1d0..2f1a894a 100644--- a/packages/ui/src/components/layout/ResizeableLayout.module.scss+++ b/packages/ui/src/components/layout/ResizeableLayout.module.scss@@ -26,7 +26,6 @@overflow: hidden;.root.hidden > & {- flex-grow: 1;flex-shrink: 1;}}diff --git a/packages/ui/src/components/meta/ColorMetaFieldView.tsx b/packages/ui/src/components/meta/ColorMetaFieldView.tsxindex b320ff87..01062438 100644--- a/packages/ui/src/components/meta/ColorMetaFieldView.tsx+++ b/packages/ui/src/components/meta/ColorMetaFieldView.tsx@@ -2,6 +2,7 @@ import {ColorInput} from '../controls';import {useSubscribableValue} from '../../hooks';import type {ColorMetaField} from '@motion-canvas/core/lib/meta';import {MetaFieldGroup} from './MetaFieldGroup';+import {useState} from 'preact/hooks';export interface ColorMetaFieldViewProps {field: ColorMetaField;@@ -9,13 +10,17 @@ export interface ColorMetaFieldViewProps {export function ColorMetaFieldView({field}: ColorMetaFieldViewProps) {const value = useSubscribableValue(field.onChanged);+ const [force, setForce] = useState(0);return (<MetaFieldGroup field={field}><ColorInputvalue={value}onChange={value => {- field.set(value ? value : null);+ field.set(value ? value : field.initial);+ // Force re-render in case the initial color was the same as the+ // previous one.+ setForce(force + 1);}}/></MetaFieldGroup>diff --git a/packages/ui/src/components/meta/MetaFieldGroup.tsx b/packages/ui/src/components/meta/MetaFieldGroup.tsxindex f05b7c3e..c6d03a1e 100644--- a/packages/ui/src/components/meta/MetaFieldGroup.tsx+++ b/packages/ui/src/components/meta/MetaFieldGroup.tsx@@ -1,6 +1,7 @@import {Group, Label} from '../controls';import type {ComponentChildren} from 'preact';import type {MetaField} from '@motion-canvas/core/lib/meta';+import {useMemo} from 'preact/hooks';export interface MetaFieldGroupProps {children: ComponentChildren;@@ -8,9 +9,25 @@ export interface MetaFieldGroupProps {}export function MetaFieldGroup({field, children}: MetaFieldGroupProps) {+ const description = useMemo(() => {+ let result = '';+ let charCount = 0;+ const words = field.description.split(' ');+ for (const word of words) {+ if (charCount + word.length > 40) {+ result += '\n';+ charCount = 0;+ }+ result += word + ' ';+ charCount += word.length + 1;+ }++ return result;+ }, [field.description]);+return (- <Group title={field.description}>- <Label title={field.description}>{field.name}</Label>+ <Group title={description}>+ <Label title={description}>{field.name}</Label>{children}</Group>);diff --git a/packages/ui/src/components/sidebar/Settings.tsx b/packages/ui/src/components/sidebar/Settings.tsxnew file mode 100644index 00000000..21a209fc--- /dev/null+++ b/packages/ui/src/components/sidebar/Settings.tsx@@ -0,0 +1,19 @@+import {Pane} from '../tabs';+import {useApplication} from '../../contexts';+import {Expandable} from '../fields';+import {MetaFieldView} from '../meta';++export function Settings() {+ const {settings} = useApplication();++ return (+ <Pane title="Settings" id="app-settings-pane">+ <Expandable title={settings.appearance.name} open>+ <MetaFieldView field={settings.appearance} />+ </Expandable>+ <Expandable title={settings.defaults.name}>+ <MetaFieldView field={settings.defaults} />+ </Expandable>+ </Pane>+ );+}diff --git a/packages/ui/src/components/sidebar/index.ts b/packages/ui/src/components/sidebar/index.tsindex d1e41751..03b2e6d0 100644--- a/packages/ui/src/components/sidebar/index.ts+++ b/packages/ui/src/components/sidebar/index.ts@@ -1,3 +1,4 @@export * from './Properties';+export * from './Settings';export * from './Threads';export * from './VideoSettings';diff --git a/packages/ui/src/components/viewport/ColorPicker.tsx b/packages/ui/src/components/viewport/ColorPicker.tsxindex 76e78a14..32ea2699 100644--- a/packages/ui/src/components/viewport/ColorPicker.tsx+++ b/packages/ui/src/components/viewport/ColorPicker.tsx@@ -26,7 +26,7 @@ function ColorPickerImpl() {'keydown',useCallback(event => {- if (event.key === 'i') {+ if (document.activeElement.tagName !== 'INPUT' && event.key === 'i') {pickColor();}},diff --git a/packages/ui/src/contexts/application.tsx b/packages/ui/src/contexts/application.tsxindex 9927b6c7..26c9cd0b 100644--- a/packages/ui/src/contexts/application.tsx+++ b/packages/ui/src/contexts/application.tsx@@ -6,6 +6,7 @@ import type {Project,Presenter,ProjectMetadata,+ SettingsMetadata,} from '@motion-canvas/core';interface Application {@@ -14,6 +15,7 @@ interface Application {renderer: Renderer;presenter: Presenter;meta: ProjectMetadata;+ settings: SettingsMetadata;}const ApplicationContext = createContext<Application | null>(null);diff --git a/packages/ui/src/index.scss b/packages/ui/src/index.scssindex 1195f853..27baba21 100644--- a/packages/ui/src/index.scss+++ b/packages/ui/src/index.scss@@ -1,4 +1,5 @@@import url('https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;700&display=swap');+@import url('https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,700;1,400;1,700&display=swap');:root {--theme: #33a6ff;@@ -20,11 +21,8 @@--duration-normal: 0.2s;--duration-fast: 0.1s;- --font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,- Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji',- 'Segoe UI Symbol';- --font-family: 'JetBrains Mono';- --font-family-mono: 'JetBrains Mono';+ --font-family: 'Roboto', sans-serif;+ --font-family-mono: 'JetBrains Mono', monospace;--font-size: 14px;--font-size-small: 12px;--font-size-big: 16px;diff --git a/packages/ui/src/main.tsx b/packages/ui/src/main.tsxindex 275de673..02ddbad9 100644--- a/packages/ui/src/main.tsx+++ b/packages/ui/src/main.tsx@@ -36,6 +36,33 @@ export function editor(project: Project) {const renderer = new Renderer(project);const presenter = new Presenter(project);+ const settings = project.settings;+ settings.appearance.color.onChanged.subscribe(() => {+ const color = settings.appearance.color.get();+ if (color) {+ document.body.style.setProperty('--theme', color.css());+ document.body.style.setProperty(+ '--theme-light',+ color.brighten(0.54).css(),+ );+ document.body.style.setProperty(+ '--theme-overlay',+ color.alpha(0.16).css(),+ );+ } else {+ document.body.style.removeProperty('--theme');+ document.body.style.removeProperty('--theme-light');+ document.body.style.removeProperty('--theme-overlay');+ }+ });+ settings.appearance.font.onChanged.subscribe(() => {+ if (settings.appearance.font.get()) {+ document.body.style.setProperty('--font-family', 'JetBrains Mono');+ } else {+ document.body.style.removeProperty('--font-family');+ }+ });+const meta = project.meta;const playerKey = `${project.name}/player`;const frameKey = `${project.name}/frame`;@@ -69,6 +96,7 @@ export function editor(project: Project) {presenter,project,meta,+ settings,}}><ShortcutsProvider>diff --git a/packages/ui/src/signals/EditorPanel.ts b/packages/ui/src/signals/EditorPanel.tsindex 7b3ddbd7..77ab4f4f 100644--- a/packages/ui/src/signals/EditorPanel.ts+++ b/packages/ui/src/signals/EditorPanel.ts@@ -3,6 +3,7 @@ export enum EditorPanel {Inspector = 'inspector-panel',Threads = 'threads-panel',Console = 'console-panel',+ Settings = 'settings-panel',Timeline = 'timeline-panel',}diff --git a/packages/vite-plugin/src/main.ts b/packages/vite-plugin/src/main.tsindex b2535a90..da95d0ce 100644--- a/packages/vite-plugin/src/main.ts+++ b/packages/vite-plugin/src/main.ts@@ -11,6 +11,7 @@ import {import {getVersions} from './versions';import {PluginOptions, isPlugin, PLUGIN_OPTIONS, ProjectData} from './plugins';import {openInExplorer} from './openInExplorer';+import * as os from 'os';export interface MotionCanvasPluginConfig {/**@@ -107,6 +108,11 @@ export default ({const resolvedEditorId = '\0virtual:editor';+ const settingsId = '\0settings';+ const settingsPath = path.resolve(+ os.homedir(),+ '.motion-canvas/settings.json',+ );const timeStamps: Record<string, number> = {};const outputPath = path.resolve(output);const projects: ProjectData[] = [];@@ -244,17 +250,30 @@ export default ({}}+ let parsed = {};+ try {+ parsed = JSON.parse(+ await fs.promises.readFile(settingsPath, 'utf8'),+ );+ } catch (_) {+ // Ignore an invalid settings file+ }+return source(...imports,`import {bootstrap} from '@motion-canvas/core/lib/app';`,+ `import {MetaFile} from '@motion-canvas/core/lib/meta';`,`import metaFile from './${metaFile}';`,`import config from './${name}';`,+ `const settings = new MetaFile('settings', '${settingsId}');`,+ `settings.loadData(${JSON.stringify(parsed)});`,`export default bootstrap(`,` '${name}',`,` ${versions},`,` [${pluginNames.join(', ')}],`,` config,`,- ` metaFile`,+ ` metaFile,`,+ ` settings,`,`);`,);}@@ -382,12 +401,24 @@ export default ({}server.ws.on('motion-canvas:meta', async ({source, data}, client) => {- timeStamps[source] = Date.now();- await fs.promises.writeFile(- source,- JSON.stringify(data, undefined, 2),- 'utf8',- );+ if (source === settingsId) {+ const outputDirectory = path.dirname(settingsPath);+ if (!fs.existsSync(outputDirectory)) {+ fs.mkdirSync(outputDirectory, {recursive: true});+ }+ await fs.promises.writeFile(+ settingsPath,+ JSON.stringify(data, undefined, 2),+ 'utf8',+ );+ } else {+ timeStamps[source] = Date.now();+ await fs.promises.writeFile(+ source,+ JSON.stringify(data, undefined, 2),+ 'utf8',+ );+ }client.send('motion-canvas:meta-ack', {source});});server.ws.on(