Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #4365 from ynput/feature/user-docs_adjustments

Browse source
This commit is contained in:
Milan Kolar 2023-02-03 11:10:55 +01:00 • committed by GitHub
commit fbe4abf9ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

71
website/docs/artist_getting_started.md
View file

@ -7,6 +7,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Working in the studio
In studio environment you should have OpenPype already installed and deployed, so you can start using it without much setup. Your admin has probably put OpenPype icon on your desktop or even had your computer set up so OpenPype will start automatically.
@ -15,70 +16,66 @@ If this is not the case, please contact your administrator to consult on how to
## Working from home
If you are working from home though, you'll need to install it yourself. You should, however, receive the OpenPype installer files from your studio
admin, supervisor or production, because OpenPype versions and executables might not be compatible between studios.
If you are working from **home** though, you'll **need to install** it yourself. You should, however, receive the OpenPype installer files from your studio
admin, supervisor or production, because OpenPype versions and executables might not be compatible between studios.
To install OpenPype you just need to unzip it anywhere on the disk
Installing OpenPype is possible by Installer or by unzipping downloaded ZIP archive to any drive location.
To use it, you have two options
**openpype_gui.exe** is the most common for artists. It runs OpenPype GUI in system tray. From there you can run all the available tools. To use any of the features, OpenPype must be running in the tray.
**openpype_console.exe** in useful for debugging and error reporting. It opens console window where all the necessary information will appear during user's work.
:::tip Using the OpenPype Installer
See the [Installation section](artist_install.md) for more information on how to use the OpenPype Installer
:::
<Tabs
groupId="platforms"
defaultValue="win"
values={[
{label: 'Windows', value: 'win'},
{label: 'Linux', value: 'linux'},
{label: 'Mac', value: 'mac'},
]}>
You can run OpenPype by desktop "OP" icon (if it exists after installing) or by directly executing
<TabItem value="win">
**openpype_gui.exe** located in the OpenPype folder. This executable being suitable **for artists**.
WIP - Windows instructions once installers are finished
or alternatively by
</TabItem>
<TabItem value="linux">
**openpype_console.exe** which is more suitable for **TDs/Admin** for debugging and error reporting. This one runs with
opened console window where all the necessary info will appear during user's work session.
WIP - Linux instructions once installers are finished
:::tip Is OpenPype running?
OpenPype runs in the operating system's tray. If you see turquoise OpenPype icon in the tray you can easily tell OpenPype is currently running.
Keep in mind that on Windows this icon might be hidden by default, in which case, the artist can simply drag the icon down to the tray.
:::
</TabItem>
<TabItem value="mac">
WIP - Mac instructions once installers are finished
</TabItem>
</Tabs>
![Systray](assets/artist_systray.png)
## First Launch
When you first start OpenPype, you will be asked to give it some basic information.
When you first start OpenPype, you will be asked to fill in some basic information.
### MongoDB
In most cases that will only be your studio MongoDB Address.
In most cases you will only have to supply the MongoDB Address.
It's the database URL you should have received from your Studio admin and often will look like this
It is a URL that you should receive from you studio and most often will look like this `mongodb://username:passwword@mongo.mystudiodomain.com:12345` or `mongodb://192.168.100.15:27071`, it really depends on your studio setup. When OpenPype Igniter
`mongodb://username:passwword@mongo.mystudiodomain.com:12345`
or
`mongodb://192.168.100.15:27071`
it really depends on your studio setup. When OpenPype Igniter
asks for it, just put it in the corresponding text field and press `install` button.
### OpenPype Version Repository
Sometimes your studio might also ask you to fill in the path to it's version
repository. This is a location where OpenPype will be looking for when checking
if it's up to date and where updates are installed from automatically.
Sometimes your Studio might also ask you to fill in the path to its version
repository. This is a location where OpenPype will search for the latest versions, check
if it's up to date and where updates are installed from automatically.
This pat is usually taken from the database directly, so you shouldn't need it.
This path is usually taken from the database directly, so you shouldn't need it.
## Updates
If you're connected to your studio, OpenPype will check for, and install updates automatically every time you run it. That's why during the first start, it will go through a quick update installation process, even though you might have just installed it.
If you're connected to your Studio, OpenPype will check for, and install updates automatically every time you run it. That's why during the first start it can go through a quick update installation process, even though you might have just installed it.
## Advanced use
## Advanced Usage
For more advanced use of OpenPype commands please visit [Admin section](admin_openpype_commands.md).