|
1 | | -# studiorack-core |
| 1 | +# studiorack-core has been deprecated |
2 | 2 |
|
3 | | - |
| 3 | +StudioRack core was a prototype of an open-source audio plugin core functions. It showed what was possible by publishing reusable code and making it available to command line tools, apps and websites. |
4 | 4 |
|
5 | | -Common methods package shared across StudioRack CLI, app and website for handling installing DAW VST plugin dependencies. |
| 5 | +This core codebase required maintenance to keep up-to-date and was missing important features such as: |
6 | 6 |
|
7 | | - |
| 7 | +- Support for projects/presets |
| 8 | +- Target specific operating systems and architectures |
| 9 | +- File hashes for security |
| 10 | +- Multiple plugin/archive formats |
8 | 11 |
|
9 | | -## Features |
| 12 | +We have now combined forces with the Owlplug team, to define an open-source shared audio package manager specification and GitHub organization. The new core codebase supports those important features and will allow the standards to scale beyond StudioRack and Owlplug to other audio package managers. |
10 | 13 |
|
11 | | -- admin - Standalone script for running plugin installations with admin privileges |
12 | | -- api - Helper methods for getting data via web requests |
13 | | -- config- Reading and writing configuration settings |
14 | | -- file - Helper methods for manipulating local files |
15 | | -- plugin - Logic for searching and installing plugins |
16 | | -- project - Logic for searching and indexing audio projects |
17 | | -- tool - Utilities and tools for validating plugins |
18 | | -- utils - Other helper methods and string utilities |
19 | | - |
20 | | -## Installation |
21 | | - |
22 | | -To install the common package, run the command: |
23 | | - |
24 | | - npm install @studiorack/core |
25 | | - |
26 | | -Import the package using: |
27 | | - |
28 | | - import { toolInstall } from '@studiorack/core'; |
29 | | - |
30 | | -Then use the available methods as normal. |
31 | | - |
32 | | -## Developer information |
33 | | - |
34 | | -StudioRack Core was built using: |
35 | | - |
36 | | -- NodeJS 20.x |
37 | | -- TypeScript 5.x |
38 | | - |
39 | | -## Installation |
40 | | - |
41 | | -To install, build and run code locally, first install dependencies: |
42 | | - |
43 | | - npm install |
44 | | - |
45 | | -## Usage |
46 | | - |
47 | | -Run dev command: |
48 | | - |
49 | | - npm run dev |
50 | | - |
51 | | -Or to create and run a production build: |
52 | | - |
53 | | - npm run build |
54 | | - npm start |
55 | | - |
56 | | -## Deployment |
57 | | - |
58 | | -This package is versioned using git tags: |
59 | | - |
60 | | - npm version patch |
61 | | - git push && git push origin --tags |
62 | | - |
63 | | -It is published to npm using: |
64 | | - |
65 | | - npm publish |
| 14 | +Check it the new project here: https://github.com/open-audio-stack/open-audio-stack-core |
66 | 15 |
|
67 | 16 | ## Contact |
68 | 17 |
|
|
0 commit comments