[Version] Bump version to v0.5.0 (#1)

* [fix] update actions * update action * typo * lint * update url to oss * update zolly * lint * [fix] url of doc
openxrlab · Sep 11, 2023 · 952400b · 952400b
1 parent 0cd1323
commit 952400b
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 31 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -8,7 +8,7 @@ concurrency:
 
 jobs:
   lint:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python 3.8

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,22 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  apt_packages:
+    - pandoc
+    - graphviz
+  tools:
+    python: "3.10"
+
+formats: all
+
+python:
+  install:
+  - method: pip
+    path: .
+    # pip install .[all]
+    extra_requirements:
+      - all
+
+sphinx:
+  configuration: docs/en/conf.py
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ XRFeitoria is a rendering toolbox for generating synthetic data photorealistic w
 It is a part of the [OpenXRLab](https://openxrlab.org.cn/) project.
 
 <div align="center">
-    <img src="http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/pics/demo.gif"/>
+    <img src="https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/pics/demo.gif"/>
 </div>
 
 ### Major Features
@@ -66,7 +66,7 @@ xf-render bunny.obj
 ### Tutorials
 
 There are several [tutorials](/tutorials/).
-You can read them [here](http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/docs/en/_build/html/src/Tutorials.html).
+You can read them [here](https://xrfeitoria.readthedocs.io/en/latest/src/Tutorials.html).
 
 
 ### Sample codes
@@ -81,7 +81,7 @@ Please follow the instructions [here](/samples/README.md).
 | Project | Teaser | Engine |
 | :---: | :---: | :---: |
 | [Synbody: Synthetic Dataset with Layered Human Models for 3D Human Perception and Modeling](https://synbody.github.io/) | <img src="https://synbody.github.io/static/teaser.png"/> | Unreal Engine / Blender |
-| [Zolly: Zoom Focal Length Correctly for Perspective-Distorted Human Mesh Reconstruction](https://wenjiawang0312.github.io/projects/zolly/) | <img src="https://github.com/WenjiaWang0312/Zolly/blob/main/assets/demo_sota.jpg?raw=true"/> | Blender |
+| [Zolly: Zoom Focal Length Correctly for Perspective-Distorted Human Mesh Reconstruction](https://wenjiawang0312.github.io/projects/zolly/) | <img src="https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/pics/zolly.jpg"/> | Blender |
 | [SHERF: Generalizable Human NeRF from a Single Image](https://skhu101.github.io/SHERF/) | <img src="https://github.com/skhu101/SHERF/raw/main/img/SHERF_teaser.png"/> | Blender |
 | [MatrixCity: A Large-scale City Dataset for City-scale Neural Rendering and Beyond](https://city-super.github.io/matrixcity/) | <img src="https://city-super.github.io/matrixcity/img/teaser.jpg"/> | Unreal Engine |
 | [HumanLiff: Layer-wise 3D Human Generation with Diffusion Model](https://skhu101.github.io/HumanLiff/) | <img src="https://skhu101.github.io/HumanLiff/HumanLiff%20-%20Project%20Page_files/SHERF_teaser.png"/> | Blender |
@@ -113,3 +113,4 @@ If you find this project useful in your research, please consider cite:
 - [XRMoCap](https://github.com/openxrlab/xrmocap): OpenXRLab Multi-view Motion Capture Toolbox and Benchmark.
 - [XRMoGen](https://github.com/openxrlab/xrmogen): OpenXRLab Human Motion Generation Toolbox and Benchmark.
 - [XRNeRF](https://github.com/openxrlab/xrnerf): OpenXRLab Neural Radiance Field (NeRF) Toolbox and Benchmark.
+- [XRFeitoria](https://github.com/openxrlab/xrfeitoria): OpenXRLab Synthetic Data Rendering Toolbox.
diff --git a/docs/en/faq.rst b/docs/en/faq.rst
@@ -70,6 +70,6 @@ Known Issues
 Inaccurate vertices in Unreal Engine
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. _XRFeitoriaUnreal: TODO
+.. _XRFeitoriaUnreal: https://github.com/openxrlab/xrfeitoria/tree/main/src/XRFeitoriaUnreal
 
 The vertices exported from actors in Unreal Engine may be inaccurate. This is a issue in `XRFeitoriaUnreal`_ plugin.
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -18,7 +18,7 @@ Welcome to XRFeitoria's documentation!
 XRFeitoria is a rendering toolbox for generating synthetic data photorealistic with ground-truth annotations.
 It is a part of the `OpenXRLab`_ project.
 
-.. image:: http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/pics/demo.gif
+.. image:: https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/pics/demo.gif
     :alt: XRFeitoria Demo
     :align: center
 

diff --git a/docs/en/src/Samples.rst b/docs/en/src/Samples.rst
@@ -3,6 +3,6 @@
 Samples
 =========
 
-Extra sample codes which are specific to certain engine can be found in the :ref:`samples` folder.
+.. _here: https://github.com/openxrlab/xrfeitoria/tree/main/samples/
 
-.. TODO: add a link to the samples folder
+Extra sample codes which are specific to certain engine in `here`_. Please follow the instructions.
diff --git a/docs/en/src/blender-addon.md b/docs/en/src/blender-addon.md
@@ -5,13 +5,13 @@ The source code of the addon is in `src/XRFeitoriaBpy`.
 It enables you to start RPC server and manage your sequences.
 
 The addon panel is in the top-right corner of the 3D Viewport.
-![](http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/pics/blender-addon/1-addon_position.png)
+![](https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/pics/blender-addon/1-addon_position.png)
 
 Click the button `Start RPC Server` to start the RPC server. The server will listen on port 9997 to receive commands from XRFeitoria and execute them in Blender.
-![](http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/pics/blender-addon/2-start_rpc_server.png)
+![](https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/pics/blender-addon/2-start_rpc_server.png)
 
 Click the drop down box `Active` in the `Manage sequences` section to open a sequence belonging to the current level. The objects in the sequence will be loaded to the window, and the properties of the sequence such as `fps`, `frame_start`, `frame_end` and `frame_current` will be set.
-![](http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/pics/blender-addon/3-open_sequence.png)
+![](https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/pics/blender-addon/3-open_sequence.png)
 
 Click the 'x' button beside the drop down box to close the sequence.
-![](http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/pics/blender-addon/4-close_sequence.png)
+![](https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/pics/blender-addon/4-close_sequence.png)
diff --git a/pyproject.toml b/pyproject.toml
@@ -63,8 +63,8 @@ doc = [
 ]
 
 [project.urls]
-"Homepage" = "https://gitlab.bj.sensetime.com/openxrlab/xrfeitoria/xrfeitoria"
-"Bug Tracker" = "https://gitlab.bj.sensetime.com/openxrlab/xrfeitoria/xrfeitoria/-/issues"
+"Homepage" = "https://github.com/openxrlab/xrfeitoria"
+"Bug Tracker" = "https://github.com/openxrlab/xrfeitoria/issues"
 
 [project.scripts]
 xf-render = "xrfeitoria.cmd.render:app"

diff --git a/samples/setup.py b/samples/setup.py
@@ -14,17 +14,17 @@
 
 # XXX: Hard-coded assets url
 assets_url = dict(
-    bunny='http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/assets/stanford-bunny.obj',
-    koupen_chan='http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/assets/koupen_chan.fbx',
-    SMPL_XL='http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/assets/SMPL-XL-001.fbx',
-    motion_1='http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/assets/motion-greeting.fbx',
-    motion_2='http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/assets/motion-stand_to_walk_back.fbx',
-    blend_sample='http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/assets/Tree1.blend',
-    hdr_sample='http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/assets/hdr-sample.hdr',
+    bunny='https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/assets/stanford-bunny.obj',
+    koupen_chan='https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/assets/koupen_chan.fbx',
+    SMPL_XL='https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/assets/SMPL-XL-001.fbx',
+    motion_1='https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/assets/motion-greeting.fbx',
+    motion_2='https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/assets/motion-stand_to_walk_back.fbx',
+    blend_sample='https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/assets/Tree1.blend',
+    hdr_sample='https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/assets/hdr-sample.hdr',
 )
 # XXX: hard-coded unreal project url
 unreal_sample_url = (
-    'http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/unreal_project/XRFeitoriaUnreal_Sample.zip'
+    'https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/unreal_project/XRFeitoriaUnreal_Sample.zip'
 )
 asset_dir = tmp_dir / 'assets'
 

diff --git a/tutorials/01_get_started.ipynb b/tutorials/01_get_started.ipynb
@@ -123,7 +123,7 @@
    "source": [
     "✨ Running the codes above should give a result as depicted below.\n",
     "\n",
-    "![](http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/pics/tutorial-01.png)"
+    "![](https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/pics/tutorial-01.png)"
    ]
   },
   {
@@ -150,7 +150,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Ref to [doc](http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/docs/en/_build/html/init.html), you can always use ``with`` statement to ensure the engine is closed when the codes are finished."
+    "Ref to [doc](https://xrfeitoria.readthedocs.io/en/latest/init.html), you can always use ``with`` statement to ensure the engine is closed when the codes are finished."
    ]
   }
  ],

diff --git a/xrfeitoria/utils/runner.py b/xrfeitoria/utils/runner.py
@@ -26,13 +26,13 @@
 # XXX: hardcode plugin download url
 unreal_plugin_urls = dict(
     Windows={
-        '5.1': 'http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/plugins/XRFeitoriaUnreal-0.5.0-UE5.1-Windows.zip',
-        '5.2': 'http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/plugins/XRFeitoriaUnreal-0.5.0-UE5.2-Windows.zip',
+        '5.1': 'https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/plugins/XRFeitoriaUnreal-0.5.0-UE5.1-Windows.zip',
+        '5.2': 'https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/plugins/XRFeitoriaUnreal-0.5.0-UE5.2-Windows.zip',
     },
     Darwin={},
     Linux={},
 )
-blender_plugin_url = 'http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/plugins/XRFeitoriaBpy.zip'
+blender_plugin_url = 'https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/plugins/XRFeitoriaBpy.zip'
 
 
 def _rmtree(path: Path) -> None:

diff --git a/xrfeitoria/utils/setup.py b/xrfeitoria/utils/setup.py
@@ -14,12 +14,10 @@
 
 # XXX: hard-coded blender download url
 blender_compressed_urls = {
-    'Windows': 'http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/blender-3.3.10-windows-x64.zip',
-    # 'Windows': 'https://download.blender.org/release/Blender3.3/blender-3.3.10-windows-x64.zip',
+    'Windows': 'https://download.blender.org/release/Blender3.3/blender-3.3.10-windows-x64.zip',
     # 'Windows': 'https://mirrors.aliyun.com/blender/release/Blender3.3/blender-3.3.10-windows-x64.zip',
     'Darwin': None,
-    'Linux': 'http://file.bj.zoe.sensetime.com/resources/meihaiyi/xrfeitoria/blender-3.3.10-linux-x64.tar.xz'
-    # 'Linux': 'https://download.blender.org/release/Blender3.3/blender-3.3.10-linux-x64.tar.xz',
+    'Linux': 'https://download.blender.org/release/Blender3.3/blender-3.3.10-linux-x64.tar.xz',
     # 'Linux': 'https://mirror.freedif.org/blender/release/Blender3.3/blender-3.3.10-linux-x64.tar.xz',
 }