Skip to content

Commit 389b445

Browse files
committed
Remove Charcoal references from the code for now
1 parent 095d577 commit 389b445

File tree

8 files changed

+6
-40
lines changed

8 files changed

+6
-40
lines changed

Cargo.lock

Lines changed: 0 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
members = [
33
"editor",
44
"graphene",
5-
"charcoal",
65
"proc-macros",
76
"frontend/wasm",
87
]

charcoal/Cargo.toml

Lines changed: 0 additions & 13 deletions
This file was deleted.

charcoal/src/lib.rs

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/codebase/README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,12 @@ This is a great place to start learning about the Graphite codebase and its arch
44

55
## Core libraries
66

7-
Graphite's core rust codebase is split into three reusable libraries:
7+
Graphite's core rust codebase is split into two reusable libraries:
88

99
- Editor
1010
- Graphene
11-
- Charcoal
1211

13-
Each depends on its successor in the list. These are used internally but also intended for usage by third parties through Rust or linked by a project in C, C++, or another language.
12+
The Editor depends on Graphene, but Graphene can also be used alone. These are used internally but also intended for usage by third parties through Rust or linked by a project in C, C++, or another language.
1413

1514
## Code structure
1615

@@ -25,6 +24,4 @@ The main modules of the project architecture are outlined below. Some parts desc
2524
- **Graphite Editor (Backend)**: `/editor/`
2625
Used by a frontend editor client to maintain GUI state and dispatch user events. The official Graphite editor is the primary user, but others software like game engines could embed their own customized editor implementations. Depends on Graphene.
2726
- **Graphene (Document Graph Engine)**: `/graphene/`
28-
A stateless library for updating Graphite design document (GDD) files. The official Graphite CLI and editor client backend are the primary users, but this library is intended to be useful to any application that wants to link the library for the purpose of updating GDD files by sending edit operations. Optionally depends on Charcoal if rendering is required.
29-
- **Charcoal (Asset Render Engine)**: `/charcoal/`
30-
A stateless library (with the help of in-memory and/or on-disk caches for performance) for rendering Graphite's asset graph (GDA) files. The official Graphite CLI and Graphene are the primary users, but this library is intended to be useful to any application that wants to link the library for the purpose of rendering Graphite's asset graphs. For example, games can link the library and render procedural textures with customizable parametric input values.
27+
A stateless library for updating Graphite design document (GDD) files. The official Graphite CLI and editor client backend are the primary users, but this library is intended to be useful to any application that wants to link the library for the purpose of updating GDD files by sending edit operations. This also serves as the 2D render engine and this is intended to be useful to any application that wants to link the Graphene library for the purpose of rendering Graphite graphs. For example, games can link the library and render procedural textures with customizable parametric input values.

docs/design/feature-goals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Contributions welcome! If you think of something Graphite would be great for, su
5757
- Removing translucent watermarks that were applied in the same location to a batch of photos by finding their shared similarities and differences and using that as a subtraction diff
5858

5959
## Game development
60-
- Design a GUI for the game and use Charcoal to render the in-game GUI textures at runtime at the desired resolution without scaling problems, or even render it live as data updates its state
60+
- Design a GUI for the game and use Graphene to render the in-game GUI textures at runtime at the desired resolution without scaling problems, or even render it live as data updates its state
6161
- Authoring procedural noise-based textures and PBR materials
6262

6363
## Data visualization
@@ -98,4 +98,4 @@ Contributions welcome! If you think of something Graphite would be great for, su
9898
- Generating a PDF invoice based on data in a pipeline in a server
9999

100100
## Industrial control
101-
- Factory line is examining its fruit for defects. In order to verify the quality, they need to enhance the contrast, automatically orient the image and correct the lighting. They then pass the results into a machine learning algorithm to classify, and sometimes need to snoop on the stream of data to manually do quality control (ImageMagick or custom Python libraries are often used for this right now)
101+
- Factory line is examining its fruit for defects. In order to verify the quality, they need to enhance the contrast, automatically orient the image and correct the lighting. They then pass the results into a machine learning algorithm to classify, and sometimes need to snoop on the stream of data to manually do quality control (ImageMagick or custom Python libraries are often used for this right now)

docs/editor/1-overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ TODO: Add more to make a comprehensive list, finish writing definitions, separat
6464
- ## Graphite Editor (Frontend)
6565
- ## Graphite Editor (Backend)
6666
- ## Graphene (Document Graph Engine)
67-
- ## Charcoal (Asset Render Engine)
6867
- ## Trace
6968
- ## Path
7069
- ## Shape

frontend/vue.config.js

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,7 @@ module.exports = {
5757
crateDirectory: path.resolve(__dirname, "wasm"),
5858
// Remove when this issue is resolved: https://github.com/wasm-tool/wasm-pack-plugin/issues/93
5959
outDir: path.resolve(__dirname, "wasm/pkg"),
60-
watchDirectories: [
61-
path.resolve(__dirname, "../editor"),
62-
path.resolve(__dirname, "../graphene"),
63-
path.resolve(__dirname, "../charcoal"),
64-
path.resolve(__dirname, "../proc-macros"),
65-
],
60+
watchDirectories: ["../editor", "../graphene", "../proc-macros"].map((folder) => path.resolve(__dirname, folder)),
6661
})
6762
)
6863
.end();

0 commit comments

Comments
 (0)