Skip to content

Commit

Permalink
Rename to OpenCL Plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
ThatRedox committed Apr 8, 2024
1 parent 95548a9 commit 413df86
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 19 deletions.
23 changes: 6 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,12 @@
[![Stable](https://github.com/alexhliu/ChunkyClPlugin/actions/workflows/stable.yml/badge.svg)](https://github.com/alexhliu/ChunkyClPlugin/actions/workflows/stable.yml)
[![Development](https://github.com/alexhliu/ChunkyClPlugin/actions/workflows/development.yml/badge.svg)](https://github.com/alexhliu/ChunkyClPlugin/actions/workflows/development.yml)
# OpenCL Plugin

This is a plugin for [Chunky](https://github.com/chunky-dev/chunky) which harnesses the power of the GPU with OpenCL 1.2+ to accelerate rendering.

# ChunkyCL

ChunkyCL is a plugin to the Minecraft Path-tracer [Chunky](https://github.com/chunky-dev/chunky) which harnesses the power of the GPU with OpenCL 1.2+ to accelerate rendering.
It is currently a work in progress and does not support many features such as biome tinting. The core renderer itself is still under development
so render results may change drastically between versions.

## Downloads
* [2.4.X Stable Build](https://nightly.link/ThatRedox/ChunkyClPlugin/workflows/stable/master/ChunkyClPlugin.zip)
* [Latest development build](https://nightly.link/ThatRedox/ChunkyClPlugin/workflows/development/master/ChunkyClPlugin.zip)

<sub><sup>Note: Even if the build is failing, the link will link to the latest successful build. </sup></sub>
#### This is currently a work in progress and does not support many features. The core renderer itself is still under development so render results may change drastically between versions.

## Installation

### Note: If you are using Chunky `2.4.X`, use the stable build.
### Note: The latest version development version requires the `2.5.0` snapshots.
### Note: This requires the `2.5.0` snapshots.
Download the latest plugin build and extract it. In the Chunky Launcher, expand `Advanced Settings` and click on `Manage plugins`. In the `Plugin Manager` window click on `Add` and select the `.jar` file in the extracted zip file. Click on `Save` and start Chunky as usual.

![image](https://user-images.githubusercontent.com/42661490/116319916-28ef2580-a76c-11eb-9f93-86d444a349fd.png)
Expand Down Expand Up @@ -48,11 +37,11 @@ This project is setup to work with IntelliJ and CLion. The base directory is int
For hot reloading, add `-DchunkyClHotReload="<src/main/opencl directory>"` as a JVM option.

## Copyright & License
ChunkyCL is Copyright (c) 2021 - 2022, [ThatRedox](https://github.com/ThatRedox) and [Contributors](https://github.com/ThatRedox/ChunkyClPlugin/graphs/contributors).
ChunkyCL is Copyright (c) 2021 - 2022, [ThatRedox](https://github.com/ThatRedox) and contributors.

Permission to modify and redistribute is granted under the terms of the GPLv3 license. See the file `LICENSE` for the full license.

ChunkyCL uses the following 3rd party libraries:
* [Chunky](https://github.com/chunky-dev/chunky/)
* [JOCL](http://www.jocl.org/)
* [Opencl Header from the LLVM Project](https://llvm.org)
* [OpenCL header from the LLVM Project](https://llvm.org)
4 changes: 2 additions & 2 deletions src/main/resources/plugin.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "ChunkyCl",
"name": "OpenCL Plugin",
"author": "ThatRedox",
"main": "dev.thatredox.chunkynative.opencl.ChunkyCl",
"version": "0.2",
"version": "0.2.0",
"targetVersion": "2.5.0",
"description": "OpenCL rendering for Chunky."
}

0 comments on commit 413df86

Please sign in to comment.