Skip to content

Commit

Permalink
Change url to smelter.dev (#947)
Browse files Browse the repository at this point in the history
  • Loading branch information
wkozyra95 authored Feb 14, 2025
1 parent ee7bf0e commit 76fe563
Show file tree
Hide file tree
Showing 23 changed files with 86 additions and 42 deletions.
4 changes: 2 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,9 +193,9 @@ Everything in the same PR.

- Update Rust code.
- Run `cargo run --bin generate_from_types` in **`./generate`** that will generate **`./schemas/scene.schema.json`**.
- Run `pnpm run generate-types` in **`./ts`** that will generate **`./ts/live-compositor/src/api.generated.ts`**.
- Run `pnpm run generate-types` in **`./ts`** that will generate **`./ts/smelter/src/api.generated.ts`**.
- Update TypeScript code to support new changes.
- Update CHANGELOG

> To avoid problems with forgetting about adding some changes to TS, everything that shows up in PR diff for
`./ts/live-compositor/src/api.generated.ts` should be addressed in the PR that regenerated those types.
`./ts/smelter/src/api.generated.ts` should be addressed in the PR that regenerated those types.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h1 align="center">
<img src="assets/lc_logo_large.svg" width=600 alt="Smelter">
<img src="assets/smelter-logo.svg" width=600 alt="Smelter">

<a href="https://compositor.live/docs/intro">Documentation</a> |
<a href="https://smelter.dev/docs">Documentation</a> |
<a href="https://discord.gg/Cxj3rzTTag">Discord</a>
</h1>

Expand All @@ -16,11 +16,11 @@ https://github.com/user-attachments/assets/d8716866-67bd-4721-b1c2-1a1d31e1c5b5

## Where to start?

Check out our [`Getting started`](https://compositor.live/docs/intro) section.
Check out our [`Getting started`](https://smelter.dev/docs) section.

Smelter supports Linux and macOS and can be used in 3 ways:
- TypeScript SDK - [TypeScript SDK Reference](https://compositor.live/docs/typescript/api)
- Standalone media server - [API Reference](https://compositor.live/docs/api/routes).
- TypeScript SDK - [TypeScript SDK Reference](https://smelter.dev/ts-sdk)
- Standalone media server - [API Reference](https://smelter.dev/http-api).
- Element in a Membrane Framework pipeline - [https://hexdocs.pm/membrane_live_compositor_plugin](https://hexdocs.pm/membrane_live_compositor_plugin).

## Demos
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To release a new compositor version:

- Go to `Actions` -> [`package for release`](https://github.com/software-mansion/live-compositor/actions/workflows/package_for_release.yml) -> Trigger build on master using "Run workflow" drop-down menu.
- Go to `Actions` -> [`package for release`](https://github.com/software-mansion/smelter/actions/workflows/package_for_release.yml) -> Trigger build on master using "Run workflow" drop-down menu.
- Wait for a job to finish.
- Run `gh run list --workflow "package for release"` and find an ID of the workflow run that packaged release binaries. Running `./scripts/release.sh` without necessary environment variables will also display that list.
- Run
Expand Down
9 changes: 0 additions & 9 deletions assets/lc_logo_large.svg

This file was deleted.

53 changes: 53 additions & 0 deletions assets/smelter-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use crate::{
wgpu::common_pipeline::VERTEX_ENTRYPOINT_NAME,
};

const HEADER_DOCS_URL: &str = "https://compositor.live/docs/concept/shaders#header";
const HEADER_DOCS_URL: &str = "https://smelter.dev/docs/concept/shaders#header";

#[derive(Debug, thiserror::Error)]
pub struct ShaderParseError {
Expand Down
2 changes: 1 addition & 1 deletion compositor_render/src/wgpu/ctx.rs
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ pub fn create_wgpu_ctx(
let missing_features = required_features.difference(adapter.features());
if !missing_features.is_empty() {
error!("Selected adapter or its driver does not support required wgpu features. Missing features: {missing_features:?}).");
error!("You can configure some of the required features using \"SMELTER_REQUIRED_WGPU_FEATURES\" environment variable. Check https://compositor.live/docs for more.");
error!("You can configure some of the required features using \"SMELTER_REQUIRED_WGPU_FEATURES\" environment variable. Check https://smelter.dev/docs for more.");
return Err(CreateWgpuCtxError::NoAdapter);
}

Expand Down
2 changes: 1 addition & 1 deletion compositor_web/example/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import init, {create_renderer, FrameSet} from "./pkg/compositor_web.js";

const IMAGE1_URL = "https://media.tenor.com/eFPFHSN4rJ8AAAAM/example.gif";
const IMAGE2_URL = "https://compositor.live/img/logo-dark.svg";
const IMAGE2_URL = "https://smelter.dev/img/logo-dark.svg";

const image = new Image();
image.src = IMAGE2_URL;
Expand Down
2 changes: 1 addition & 1 deletion demos/2-tv_broadcast/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ function BreakingNewsText() {
align="center"
color="#000000"
backgroundColor="#FFFF00">
Leaked docs can be found at https://compositor.live/docs
Leaked docs can be found at https://smelter.dev/docs
</Text>
</View>
</View>
Expand Down
4 changes: 2 additions & 2 deletions demos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Before running demos, install JS dependencies with:
```console
npm install
```
Smelter should run on any computer with modern GPU, but if you want to check detailed requirements, visit [requirements section in docs](https://compositor.live/docs/deployment/requirements).
Smelter should run on any computer with modern GPU, but if you want to check detailed requirements, visit [requirements section in docs](https://smelter.dev/docs/deployment/requirements).

### MacOS installation guide

Expand Down Expand Up @@ -91,5 +91,5 @@ export SMELTER_WEBCAM=false

## Learn more

You can learn more from [documentation](https://compositor.live/docs/intro).
You can learn more from [documentation](https://smelter.dev/docs).
API reference and guides can be found there.
2 changes: 1 addition & 1 deletion demos/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"bugs": {
"url": "https://github.com/software-mansion/live-compositor/issues"
},
"homepage": "https://github.com/software-mansion/live-compositor#readme",
"homepage": "https://smelter.dev",
"dependencies": {
"@live-compositor/node": "^0.1.0",
"@types/fs-extra": "^11.0.2",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/concept/shaders.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Each video passed in as input gets a separate rectangle.

If there are no input textures, `plane_id` is equal to -1 and a single rectangle is passed to the shader. It is only useful for shaders that generate something in the fragment shader.

Since the compositor doesn't deal with complex geometry and most positioning/resizing/cropping should be taken care of by [layouts](https://compositor.live/docs/concept/layouts), we don't expect the users to write nontrivial vertex shaders very often. For just applying some effects to the video, fragment shaders are the way to go. This vertex shader should take care of most of your needs (for transformations that receive a single video and only process it in the fragment shader):
Since the compositor doesn't deal with complex geometry and most positioning/resizing/cropping should be taken care of by [layouts](https://smelter.dev/docs/concept/layouts), we don't expect the users to write nontrivial vertex shaders very often. For just applying some effects to the video, fragment shaders are the way to go. This vertex shader should take care of most of your needs (for transformations that receive a single video and only process it in the fragment shader):

```wgsl
struct VertexOutput {
Expand Down
2 changes: 1 addition & 1 deletion ts/create-smelter-app/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bugs": {
"url": "https://github.com/software-mansion/smelter/issues"
},
"homepage": "https://github.com/software-mansion/smelter",
"homepage": "https://smelter.dev",
"files": [
"/dist",
"/templates"
Expand Down
2 changes: 1 addition & 1 deletion ts/examples/node-examples/src/dynamic-text.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ async function run() {
);
await smelter.registerImage('image_1', {
assetType: 'svg',
url: 'https://compositor.live/img/logo.svg',
url: 'https://smelter.dev/img/logo.svg',
resolution: { width: 300, height: 300 },
});

Expand Down
Loading

0 comments on commit 76fe563

Please sign in to comment.